Go API client for openapi

The SAP SaaS Provisioning service provides REST APIs that are responsible for the registration and provisioning of multitenant applications and services.
Use the APIs in this service to perform various operations related to your multitenant applications and services. For example, to get application registration details, subscribe a tenant to your application, unsubscribe a tenant from your application, retrieve all your application subscriptions, update subscription dependencies, and to get subscription job information.

See also:

• Authorization
• Rate Limiting
• Error Response Format
• Asynchronous Jobs

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 1.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import openapi "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://saas-manager.cfapps.eu10.hana.ondemand.com

Class	Method	HTTP request	Description
ApplicationOperationsForAppProvidersAPI	DeleteApplicationAndTenantSubscriptionAsync	Delete /saas-manager/v1/application/tenants/{tenantId}/subscriptions	Unsubscribe tenant from an application
ApplicationOperationsForAppProvidersAPI	GetApplicationDetails	Get /saas-manager/v1/application	Get application registration details
ApplicationOperationsForAppProvidersAPI	GetApplicationSubscriptions	Get /saas-manager/v1/application/subscriptions	Get application subscriptions
ApplicationOperationsForAppProvidersAPI	UpdateApplicationAndTenantSubscriptionAsync	Patch /saas-manager/v1/application/tenants/{tenantId}/subscriptions	Update subscription dependencies
AsynchronousCallbackOperationsForXSUAAAPI	SubscriptionCallbackAsync	Put /saas-manager/v1/subscription-callback/{identifier}/result	Subscribe a subaccount tenant to an application
JobManagementAPI	GetStatus	Get /jobs-management/v1/jobs/{jobInstanceIdOrUniqueId}/status	Get job status
JobManagementForApplicationOperationsForAppProvidersAPI	GetJobRelatedToSaasApplicationById	Get /api/v2.0/jobs/{jobUuid}	Get job errorStatusCode
SubscriptionOperationsForAppConsumersAPI	CreateSubscriptionAsync	Post /saas-manager/v1/applications/{appName}/subscription	Subscribe to an application from a subaccount
SubscriptionOperationsForAppConsumersAPI	DeleteSubscriptionAsync	Delete /saas-manager/v1/applications/{appName}/subscription	Unsubscribe an application from a subaccount
SubscriptionOperationsForAppConsumersAPI	DeleteSubscriptionLabels	Delete /saas-manager/v1/applications/{appName}/subscription/labels	Remove all labels from a multitenant application subscription
SubscriptionOperationsForAppConsumersAPI	GetEntitledApplication	Get /saas-manager/v1/applications/{appName}	Get details of a multitenant application
SubscriptionOperationsForAppConsumersAPI	GetEntitledApplications	Get /saas-manager/v1/applications	Get all entitled multitenant applications
SubscriptionOperationsForAppConsumersAPI	GetSubscriptionLabels	Get /saas-manager/v1/applications/{appName}/subscription/labels	Get labels for a multitenant application subscription
SubscriptionOperationsForAppConsumersAPI	UpdateSubscriptionParametersAsync	Patch /saas-manager/v1/applications/{appName}/subscription	Update parameters of a multitenant application subscription
SubscriptionOperationsForAppConsumersAPI	UpsertSubscriptionLabels	Put /saas-manager/v1/applications/{appName}/subscription/labels	Assign labels to a multitenant application subscription

Documentation For Models

• ApiExceptionResponseObject
• ApiExceptionResponseObjectError
• ApplicationResourceDto
• ApplicationSubscriptionsResponseObject
• CreateSubscriptionRequestPayload
• DependenciesResponseObject
• EntitledApplicationsErrorResponseObject
• EntitledApplicationsResponseCollection
• EntitledApplicationsResponseObject
• EntitledApplicationsResponseObjectMetadata
• EntitledApplicationsResponseObjectParamsSchema
• JobErrorResponseObject
• JobStateResponseObject
• LabelAssignmentRequestPayload
• LabelsResponseObject
• NestingErrorDetailsResponseObject
• RegistrationDetailsResponseObject
• SaasAsyncSubscriptionRequestPayload
• SubscriptionsListResponseObject
• UpdateApplicationDependenciesRequestPayload
• UpdateSubscriptionRequestPayload

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

OAuth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author