Go API client for openapi

Manage Camunda Clusters and API Clients via API.

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.3.3
• 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/net/context

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

import openapi "github.com/camunda-community-hub/console-customer-api-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 openapi.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 openapi.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 openapi.ContextOperationServerIndices and openapi.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://api.cloud.camunda.io

Class	Method	HTTP request	Description
DefaultAPI	CreateBackup	Post /clusters/{clusterUuid}/backups
DefaultAPI	CreateClient	Post /clusters/{clusterUuid}/clients
DefaultAPI	CreateCluster	Post /clusters
DefaultAPI	CreateSecret	Post /clusters/{clusterUuid}/secrets
DefaultAPI	DeleteBackup	Delete /clusters/{clusterUuid}/backups/{backupId}
DefaultAPI	DeleteClient	Delete /clusters/{clusterUuid}/clients/{clientId}
DefaultAPI	DeleteCluster	Delete /clusters/{clusterUuid}
DefaultAPI	DeleteMember	Delete /members/{email}
DefaultAPI	DeleteSecret	Delete /clusters/{clusterUuid}/secrets/{secretName}
DefaultAPI	GetBackups	Get /clusters/{clusterUuid}/backups
DefaultAPI	GetClient	Get /clusters/{clusterUuid}/clients/{clientId}
DefaultAPI	GetClients	Get /clusters/{clusterUuid}/clients
DefaultAPI	GetCluster	Get /clusters/{clusterUuid}
DefaultAPI	GetClusters	Get /clusters
DefaultAPI	GetMembers	Get /members
DefaultAPI	GetParameters	Get /clusters/parameters
DefaultAPI	GetSecrets	Get /clusters/{clusterUuid}/secrets
DefaultAPI	UpdateCluster	Patch /clusters/{clusterUuid}
DefaultAPI	UpdateIpAllowlist	Put /clusters/{clusterUuid}/ipallowlist
DefaultAPI	UpdateIpWhitelist	Put /clusters/{clusterUuid}/ipwhitelist
DefaultAPI	UpdateMembers	Post /members/{email}
DefaultAPI	Wake	Put /clusters/{clusterUuid}/wake

Documentation For Models

• AssignableOrganizationRoleType
• BackupDto
• BackupStatus
• CamundaClusterStage
• Cluster
• ClusterBackupRegion
• ClusterChannel
• ClusterClient
• ClusterClientConnectionDetails
• ClusterComponentStatus
• ClusterEncryptionKey
• ClusterGeneration
• ClusterIpallowlistInner
• ClusterLinks
• ClusterPlanType
• ClusterRegion
• ClusterStatus
• CreateCluster200Response
• CreateClusterBody
• CreateClusterClientBody
• CreateSecretBody
• CreatedClusterClient
• CreatedClusterClientLinks
• IpAllowListBody
• IpWhiteListBody
• Member
• OrganizationRole
• OrganizationRoleADMIN
• OrganizationRoleANALYST
• OrganizationRoleDEVELOPER
• OrganizationRoleMODELER
• OrganizationRoleOPERATIONSENGINEER
• OrganizationRoleTASKUSER
• OrganizationRoleVISITOR
• Parameters
• ParametersChannelsInner
• ParametersChannelsInnerAllowedGenerationsInner
• ParametersRegionsInner
• ParametersRegionsInnerBackupsInner
• ParametersRegionsInnerBackupsInnerRegionsInner
• PostMemberBody
• UpdateClusterRequest

Documentation For Authorization

Authentication schemes defined for the API:

bearer

• Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), openapi.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