Go API client for unifiedsdkgo

Allow registration of information needed for routing GLCP APIs.

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: v1alpha1
• Package version: 0.0.1
• Generator version: 7.10.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit http://www.hpe.com/greenlake

Installation

Install the following dependencies:

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

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

import unifiedsdkgo "github.com/guptavip20/https://github.com/guptavip20/unified-api-sdk-go"

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 unifiedsdkgo.ContextServerIndex of type int.

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

Templated Server URL

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

ctx := context.WithValue(context.Background(), unifiedsdkgo.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 unifiedsdkgo.ContextOperationServerIndices and unifiedsdkgo.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to http://localhost:5001

Class	Method	HTTP request	Description
UnifiedapioasAPI	CreateAPIGroup	Post /unified-routing/v1alpha1/api-groups	Create API group.
UnifiedapioasAPI	CreateInstance	Post /unified-routing/v1alpha1/application-instances	Create application instance.
UnifiedapioasAPI	CreateProvision	Post /unified-routing/v1alpha1/customer-provisions	Create customer provision.
UnifiedapioasAPI	DeleteAPIGroup	Delete /unified-routing/v1alpha1/api-groups	Remove API group.
UnifiedapioasAPI	DeleteAPIGroupOnID	Delete /unified-routing/v1alpha1/api-groups/{id}	Remove API Group by ID.
UnifiedapioasAPI	GetAPIGroup	Get /unified-routing/v1alpha1/api-groups	List API groups.
UnifiedapioasAPI	GetAPIGroupOnID	Get /unified-routing/v1alpha1/api-groups/{id}	Get API group by ID.
UnifiedapioasAPI	GetProvisionOnID	Get /unified-routing/v1alpha1/customer-provisions/{id}	Get customer provision by ID.
UnifiedapioasAPI	ListInstances	Get /unified-routing/v1alpha1/application-instances	List application instances.
UnifiedapioasAPI	ListProvisions	Get /unified-routing/v1alpha1/customer-provisions	List customer provisions.
UnifiedapioasAPI	PatchInstance	Patch /unified-routing/v1alpha1/application-instances	Update fields of an application instance.
UnifiedapioasAPI	RemoveInstance	Delete /unified-routing/v1alpha1/application-instances	Remove application instances.
UnifiedapioasAPI	RemoveProvision	Delete /unified-routing/v1alpha1/customer-provisions	Remove customer provisions.
UnifiedapioasAPI	RemoveProvisionOnID	Delete /unified-routing/v1alpha1/customer-provisions/{id}	Remove customer provision by ID.

Documentation For Models

• ApiGroupBasic
• ApiGroupExtended
• ApiGroupList
• AppInstanceBasic
• AppInstanceExtended
• AppInstanceList
• AppInstancePatch
• CustomerProvisionBasic
• CustomerProvisionExtended
• CustomerProvisionList
• ErrorCodeMsg

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), unifiedsdkgo.ContextAccessToken, "BEARER_TOKEN_STRING")
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