Go API client for openapi

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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.0-SNAPSHOT
• 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/shnplr/kssapi"

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 http://localhost:9080

Class	Method	HTTP request	Description
ApisResourceApi	ApisResourcesGet	Get /apis/resources
AuthorizationResourceApi	ApisAuthorizationV1NamespacesNamespaceLocalresourceaccessreviewsPost	Post /apis/authorization/v1/namespaces/{namespace}/localresourceaccessreviews
AuthorizationResourceApi	ApisAuthorizationV1ResourceaccessreviewsPost	Post /apis/authorization/v1/resourceaccessreviews
AuthorizationResourceApi	ApisAuthorizationV1SelfsubjectaccessreviewsPost	Post /apis/authorization/v1/selfsubjectaccessreviews
AuthorizationResourceApi	ApisAuthorizationV1SubjectaccessreviewsPost	Post /apis/authorization/v1/subjectaccessreviews
KafkaAppsResourceApi	ApisAppsV1KafkaappsGet	Get /apis/apps/v1/kafkaapps
KafkaAppsResourceApi	ApisAppsV1NamespacesNamespaceKafkaappsGet	Get /apis/apps/v1/namespaces/{namespace}/kafkaapps
KafkaAppsResourceApi	ApisAppsV1NamespacesNamespaceKafkaappsNameDelete	Delete /apis/apps/v1/namespaces/{namespace}/kafkaapps/{name}
KafkaAppsResourceApi	ApisAppsV1NamespacesNamespaceKafkaappsNameGet	Get /apis/apps/v1/namespaces/{namespace}/kafkaapps/{name}
KafkaAppsResourceApi	ApisAppsV1NamespacesNamespaceKafkaappsNamePut	Put /apis/apps/v1/namespaces/{namespace}/kafkaapps/{name}
KafkaAppsResourceApi	ApisAppsV1NamespacesNamespaceKafkaappsPost	Post /apis/apps/v1/namespaces/{namespace}/kafkaapps
KafkaRbacResourceApi	ApisKafkaRbacV1KafkarolebindingsGet	Get /apis/kafka.rbac/v1/kafkarolebindings
KafkaRbacResourceApi	ApisKafkaRbacV1NamespacesNamespaceKafkarolebindingsGet	Get /apis/kafka.rbac/v1/namespaces/{namespace}/kafkarolebindings
KafkaRbacResourceApi	ApisKafkaRbacV1NamespacesNamespaceKafkarolebindingsPost	Post /apis/kafka.rbac/v1/namespaces/{namespace}/kafkarolebindings
KafkaTopicsResourceApi	ApisKafkaTopicV1NamespacesNamespaceTopicsGet	Get /apis/kafka.topic/v1/namespaces/{namespace}/topics
KafkaTopicsResourceApi	ApisKafkaTopicV1NamespacesNamespaceTopicsNameConfigsalterPost	Post /apis/kafka.topic/v1/namespaces/{namespace}/topics/{name}/configs:alter
KafkaTopicsResourceApi	ApisKafkaTopicV1NamespacesNamespaceTopicsNameDelete	Delete /apis/kafka.topic/v1/namespaces/{namespace}/topics/{name}
KafkaTopicsResourceApi	ApisKafkaTopicV1NamespacesNamespaceTopicsNameGet	Get /apis/kafka.topic/v1/namespaces/{namespace}/topics/{name}
KafkaTopicsResourceApi	ApisKafkaTopicV1NamespacesNamespaceTopicsPost	Post /apis/kafka.topic/v1/namespaces/{namespace}/topics
KafkaTopicsResourceApi	ApisKafkaTopicV1NamespacesNamespaceTopicsSyncPost	Post /apis/kafka.topic/v1/namespaces/{namespace}/topics/sync
KafkaTopicsResourceApi	ApisKafkaTopicV1TopicsGet	Get /apis/kafka.topic/v1/topics
ProjectsResourceApi	ApisProjectV1ProjectsGet	Get /apis/project/v1/projects
ProjectsResourceApi	ApisProjectV1ProjectsNameDelete	Delete /apis/project/v1/projects/{name}
ProjectsResourceApi	ApisProjectV1ProjectsNameGet	Get /apis/project/v1/projects/{name}
ProjectsResourceApi	ApisProjectV1ProjectsPost	Post /apis/project/v1/projects
RbacAuthResourceApi	ApisRbacAuthorizationV1ClusterrolebindingsGet	Get /apis/rbac.authorization/v1/clusterrolebindings
RbacAuthResourceApi	ApisRbacAuthorizationV1ClusterrolebindingsNameDelete	Delete /apis/rbac.authorization/v1/clusterrolebindings/{name}
RbacAuthResourceApi	ApisRbacAuthorizationV1ClusterrolebindingsNameGet	Get /apis/rbac.authorization/v1/clusterrolebindings/{name}
RbacAuthResourceApi	ApisRbacAuthorizationV1ClusterrolebindingsNamePut	Put /apis/rbac.authorization/v1/clusterrolebindings/{name}
RbacAuthResourceApi	ApisRbacAuthorizationV1ClusterrolebindingsPost	Post /apis/rbac.authorization/v1/clusterrolebindings
RbacAuthResourceApi	ApisRbacAuthorizationV1ClusterrolebindingsdeletePost	Post /apis/rbac.authorization/v1/clusterrolebindings:delete
RbacAuthResourceApi	ApisRbacAuthorizationV1ClusterrolesGet	Get /apis/rbac.authorization/v1/clusterroles
RbacAuthResourceApi	ApisRbacAuthorizationV1ClusterrolesNameGet	Get /apis/rbac.authorization/v1/clusterroles/{name}
RbacAuthResourceApi	ApisRbacAuthorizationV1NamespacesNamespaceRolebindingsGet	Get /apis/rbac.authorization/v1/namespaces/{namespace}/rolebindings
RbacAuthResourceApi	ApisRbacAuthorizationV1NamespacesNamespaceRolebindingsNameDelete	Delete /apis/rbac.authorization/v1/namespaces/{namespace}/rolebindings/{name}
RbacAuthResourceApi	ApisRbacAuthorizationV1NamespacesNamespaceRolebindingsNameGet	Get /apis/rbac.authorization/v1/namespaces/{namespace}/rolebindings/{name}
RbacAuthResourceApi	ApisRbacAuthorizationV1NamespacesNamespaceRolebindingsNamePut	Put /apis/rbac.authorization/v1/namespaces/{namespace}/rolebindings/{name}
RbacAuthResourceApi	ApisRbacAuthorizationV1NamespacesNamespaceRolebindingsPost	Post /apis/rbac.authorization/v1/namespaces/{namespace}/rolebindings
RbacAuthResourceApi	ApisRbacAuthorizationV1NamespacesNamespaceRolebindingsdeletePost	Post /apis/rbac.authorization/v1/namespaces/{namespace}/rolebindings:delete
RbacAuthResourceApi	ApisRbacAuthorizationV1RolebindingsGet	Get /apis/rbac.authorization/v1/rolebindings
UserGroupsResourceApi	ApisUserV1GroupsGet	Get /apis/user/v1/groups
UserGroupsResourceApi	ApisUserV1GroupsNameGet	Get /apis/user/v1/groups/{name}
UserGroupsResourceApi	ApisUserV1GroupsNamePut	Put /apis/user/v1/groups/{name}
UserGroupsResourceApi	ApisUserV1GroupsPost	Post /apis/user/v1/groups
UserGroupsResourceApi	ApisUserV1UsersGet	Get /apis/user/v1/users
UserGroupsResourceApi	ApisUserV1UsersNameGet	Get /apis/user/v1/users/{name}

Documentation For Models

• AlterConfigBatchRequest
• AlterConfigDataItem
• ApiResource
• ApiResourceList
• ClusterRole
• ClusterRoleBinding
• ClusterRoleBindingList
• ClusterRoleList
• CreateTopicConfigDataItem
• CreateTopicRequest
• Group
• GroupList
• KafkaApplication
• KafkaApplicationList
• KafkaRbacSummary
• KafkaRbacSummaryList
• KafkaRole
• KafkaRoleBindingRequest
• KafkaTopicData
• KafkaTopicDataList
• LocalResourceAccessReview
• NonResourceAttributes
• PartitionInfo
• PolicyRule
• Project
• ProjectList
• ResourceAccessReview
• ResourceAccessReviewResponse
• ResourceAttributes
• ResourcePattern
• RoleBinding
• RoleBindingList
• SelfSubjectAccessReview
• SelfSubjectAccessReviewSpec
• Status
• StatusCause
• StatusDetails
• Subject
• SubjectAccessReview
• SubjectAccessReviewResponse
• SubjectAccessReviewStatus
• TopicConfigData
• User
• UserList

Documentation For Authorization

Authentication schemes defined for the API:

SecurityScheme

• Type: OAuth
• Flow: implicit
• Authorization URL: https://login.microsoftonline.com/c6198395-22e6-4778-9809-ac8dcfd76901/v2.0/protocol/openid-connect/auth
• 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