Go API client for v2

OAuth Public 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: 0.0.1-alpha1
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://confluent.slack.com/app_redirect?channel=oauth-eng

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 sw "./v2"

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(), sw.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(), sw.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(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.confluent.cloud

Class	Method	HTTP request	Description
IdentityPoolsIamV2Api	CreateIamV2IdentityPool	Post /iam/v2/identity-providers/{provider_id}/identity-pools	Create an Identity Pool
IdentityPoolsIamV2Api	DeleteIamV2IdentityPool	Delete /iam/v2/identity-providers/{provider_id}/identity-pools/{id}	Delete an Identity Pool
IdentityPoolsIamV2Api	GetIamV2IdentityPool	Get /iam/v2/identity-providers/{provider_id}/identity-pools/{id}	Read an Identity Pool
IdentityPoolsIamV2Api	ListIamV2IdentityPools	Get /iam/v2/identity-providers/{provider_id}/identity-pools	List of Identity Pools
IdentityPoolsIamV2Api	UpdateIamV2IdentityPool	Patch /iam/v2/identity-providers/{provider_id}/identity-pools/{id}	Update an Identity Pool
IdentityProvidersIamV2Api	CreateIamV2IdentityProvider	Post /iam/v2/identity-providers	Create an Identity Provider
IdentityProvidersIamV2Api	DeleteIamV2IdentityProvider	Delete /iam/v2/identity-providers/{id}	Delete an Identity Provider
IdentityProvidersIamV2Api	GetIamV2IdentityProvider	Get /iam/v2/identity-providers/{id}	Read an Identity Provider
IdentityProvidersIamV2Api	ListIamV2IdentityProviders	Get /iam/v2/identity-providers	List of Identity Providers
IdentityProvidersIamV2Api	UpdateIamV2IdentityProvider	Patch /iam/v2/identity-providers/{id}	Update an Identity Provider

Documentation For Models

• Error
• ErrorSource
• Failure
• IamV2IdentityPool
• IamV2IdentityPoolList
• IamV2IdentityProvider
• IamV2IdentityProviderList
• IamV2IdentityProviderUpdate
• IamV2Jwks
• ListMeta
• ObjectMeta
• ObjectReference

Documentation For Authorization

api-key

• Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
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

[email protected]