No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
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.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
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 configmanager "github.com/Gemini-Commerce/go-client-configmanager"
To use a proxy, set the environment variable HTTP_PROXY
:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
Default configuration comes with Servers
field that contains server objects as defined in the OpenAPI specification.
For using other server than the one defined on index 0 set context value configmanager.ContextServerIndex
of type int
.
ctx := context.WithValue(context.Background(), configmanager.ContextServerIndex, 1)
Templated server URL is formatted using default variables from configuration or from context value configmanager.ContextServerVariables
of type map[string]string
.
ctx := context.WithValue(context.Background(), configmanager.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Note, enum values are always validated and all unused variables are silently ignored.
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 configmanager.ContextOperationServerIndices
and configmanager.ContextOperationServerVariables
context maps.
ctx := context.WithValue(context.Background(), configmanager.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), configmanager.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
All URIs are relative to https://config-manager.api.gogemini.io
Class | Method | HTTP request | Description |
---|---|---|---|
ConfigManagerAPI | ConfigManagerBulkSetConfigs | Post /configmanager.ConfigManager/BulkSetConfigs | BulkSetConfigs |
ConfigManagerAPI | ConfigManagerGetConfig | Post /configmanager.ConfigManager/GetConfig | GetConfig |
ConfigManagerAPI | ConfigManagerGetTenantIdByCode | Post /configmanager.ConfigManager/GetTenantIdByCode |
- BulkSetConfigsRequestConfig
- ConfigmanagerBulkSetConfigsRequest
- ConfigmanagerConfigResponse
- ConfigmanagerGetConfigRequest
- ConfigmanagerGetTenantIdByCodeRequest
- ConfigmanagerGetTenantIdByCodeResponse
- ProtobufAny
- RpcStatus
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
Note, each API key must be added to a map of map[string]APIKey
where the key is: Authorization and passed in as the auth context for each request.
Example
auth := context.WithValue(
context.Background(),
configmanager.ContextAPIKeys,
map[string]configmanager.APIKey{
"Authorization": {Key: "API_KEY_STRING"},
},
)
r, err := client.Service.Operation(auth, args)
- Type: OAuth
- Flow: implicit
- Authorization URL:
- Scopes: N/A
Example
auth := context.WithValue(context.Background(), configmanager.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, configmanager.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
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