Skip to content

Latest commit

 

History

History
213 lines (142 loc) · 12.7 KB

README.md

File metadata and controls

213 lines (142 loc) · 12.7 KB

RHOAS Core SDKs

If you are moving a project from the old RHOAS SDKs to core read this moving doc to get started.

Supported Langauge SDK
TypeScript app-services-sdk-ts
Python app-services-sdk-python
Java app-services-sdk-java
Go app-services-sdk-go

Structure

RHOAS SDK's are delivered as set of individual packages. SDK's are divided into two types:

  • Management SDKs - support creating services
  • Instance SDKs - support direct interaction with services

Purpose of this repository

Repository contains source code for openapi based generator along with automation scripts that generate all underlying RHOAS SDKS.

RHOAS SDK for Typescript

Typescript packages and API clients for RHOAS services

Prequisites

Management SDK's

Name Package name Status Version NPM Docs
kafka @rhoas/kafka-management-sdk beta kafkashield npm doc
service-accounts @rhoas/service-accounts-sdk alpha sashield npm doc
connector @rhoas/connector-management-sdk alpha connectorshield npm doc
service registry @rhoas/registry-management-sdk alpha registryshield npm doc
smart events @rhoas/smart-events-management-sdk alpha smarteventsshield npm doc

Instances SDK's

Name Package name Status Version NPM Docs
kafka @rhoas/kafka-instance-sdk beta kinstanceshield npm doc
service registry @rhoas/registry-instance-sdk beta srinstanceshield npm doc

Docs

Documentation

Examples

Examples

RHOAS SDK for Python

Python packages and API clients for Red Had OpenShift Application Services (RHOAS)

Prequisites

Installation

Currently all RHOAS SDKs are bundled together. To install the RHOAS SDK with the pip package installer:

$ python -m pip install rhoas-sdks

RHOAS App Services SDK for Python

All packages are now available and can be accessed by just importing them as shown below:

API Status Package
KafkaManagement beta import python rhoas_kafka_mgmt_sdk
ServiceRegistryManagement alpha import rhoas_service_registry_mgmt_sdk
ConnectorManagement alpha import rhoas_connector_mgmt_sdk
ServiceAccounts alpha import rhoas_service_accounts_mgmt_sdk

Instances SDKs

API Status Package
KafkaInstance beta import rhoas_kafka_instance_sdk
RegistryInstance beta import rhoas_registry_instance_sdk

Documentation

Documentation

Examples

Examples

RHOAS SDK for Java

Java packages and API clients for RHOAS services

Prequisites

Management SDK's

Name Artifact Id Status Version Package Docs
kafka kafka-management-sdk beta 1.1.2 info doc
service accounts service-accounts-sdk alpha 1.1.2 info doc
service registry registry-management-sdk alpha 0.0.6 info doc
connector-management connector-management-sdk alpha 0.0.6 info doc
smart-events-management smart-events-management-sdk alpha 0.0.6 info doc

Instances SDK's

Name Package name Status Version Package Docs
kafka kafka-instance-sdk beta 1.1.2 info doc
service registry TBA TBA TBA TBA TBA

Docs

Documentation

RHOAS SDK for Go

Go Reference

Go packages and API clients for Red Hat OpenShift Application Services (RHOAS)

Prequisites

Installation

Install the RHOAS SDK with go get:

$ go get github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go

Import:

import "github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go"

Management SDKs

API Status Package
KafkaManagement beta github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go/kafkamgmt/apiv1
Service Account Management alpha github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go/serviceaccountmgmt/apiv1
ServiceRegistryManagement alpha github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go/registrymgmt/apiv1
ConnectorManagement alpha github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go/connectormgmt/apiv1

Instances SDKs

API Status Package
KafkaInstance beta github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go/kafkainstance/apiv1
RegistryInstance beta github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go/registryinstance/apiv1internal

Documentation

Documentation

Examples

Examples