Skip to content

Latest commit

 

History

History
281 lines (233 loc) · 16.8 KB

README.md

File metadata and controls

281 lines (233 loc) · 16.8 KB

Go API client for client

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: 6.8.0
  • Package version: 1.0.0
  • Generator version: 7.7.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 client "github.com/Unleash/unleash-server-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 client.ContextServerIndex of type int.

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

Templated Server URL

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

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

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

Documentation for API Endpoints

All URIs are relative to https://us.app.unleash-hosted.com/ushosted

Class Method HTTP request Description
APITokensAPI CreateApiToken Post /api/admin/api-tokens Create API token
APITokensAPI DeleteApiToken Delete /api/admin/api-tokens/{token} Delete API token
APITokensAPI GetAllApiTokens Get /api/admin/api-tokens Get API tokens
APITokensAPI GetApiTokensByName Get /api/admin/api-tokens/{name} Get API tokens by name
APITokensAPI UpdateApiToken Put /api/admin/api-tokens/{token} Update API token
AuthAPI GetOidcSettings Get /api/admin/auth/oidc/settings Get OIDC auth settings
AuthAPI GetPermissions Get /api/admin/permissions Gets available permissions
AuthAPI GetSamlSettings Get /api/admin/auth/saml/settings Get SAML auth settings
AuthAPI GetSimpleSettings Get /api/admin/auth/simple/settings Get Simple auth settings
AuthAPI SetOidcSettings Post /api/admin/auth/oidc/settings Set OIDC settings
AuthAPI SetSamlSettings Post /api/admin/auth/saml/settings Update SAML auth settings
AuthAPI SetSimpleSettings Post /api/admin/auth/simple/settings Update Simple auth settings
ChangeRequestsAPI GetProjectChangeRequestConfig Get /api/admin/projects/{projectId}/change-requests/config Retrieves change request configuration for a project
ChangeRequestsAPI UpdateProjectChangeRequestConfig Put /api/admin/projects/{projectId}/environments/{environment}/change-requests/config Updates change request configuration for an environment in the project
ContextAPI CreateContextField Post /api/admin/context Create a context field
ContextAPI DeleteContextField Delete /api/admin/context/{contextField} Delete an existing context field
ContextAPI GetContextField Get /api/admin/context/{contextField} Gets context field
ContextAPI GetContextFields Get /api/admin/context Gets configured context fields
ContextAPI UpdateContextField Put /api/admin/context/{contextField} Update an existing context field
EnvironmentsAPI CreateEnvironment Post /api/admin/environments Creates a new environment
EnvironmentsAPI GetAllEnvironments Get /api/admin/environments Get all environments
EnvironmentsAPI GetEnvironment Get /api/admin/environments/{name} Get the environment with `name`
EnvironmentsAPI GetProjectEnvironments Get /api/admin/environments/project/{projectId} Get the environments available to a project
EnvironmentsAPI RemoveEnvironment Delete /api/admin/environments/{name} Deletes an environment by name
EnvironmentsAPI UpdateEnvironment Put /api/admin/environments/update/{name} Updates an environment by name
ProjectsAPI AddEnvironmentToProject Post /api/admin/projects/{projectId}/environments Add an environment to a project.
ProjectsAPI CreateProject Post /api/admin/projects Create project
ProjectsAPI DeleteProject Delete /api/admin/projects/{projectId} Delete project
ProjectsAPI GetProjectAccess Get /api/admin/projects/{projectId}/access Get users and groups in project
ProjectsAPI GetProjects Get /api/admin/projects Get a list of all projects.
ProjectsAPI RemoveEnvironmentFromProject Delete /api/admin/projects/{projectId}/environments/{environment} Remove an environment from a project.
ProjectsAPI SetProjectAccess Put /api/admin/projects/{projectId}/access Set users and groups to roles in the current project
ProjectsAPI UpdateProject Put /api/admin/projects/{projectId} Update project
ProjectsAPI UpdateProjectEnterpriseSettings Put /api/admin/projects/{projectId}/settings Update project enterprise settings
ServiceAccountsAPI CreateServiceAccount Post /api/admin/service-account Create a service account.
ServiceAccountsAPI CreateServiceAccountToken Post /api/admin/service-account/{id}/token Create a token for a service account.
ServiceAccountsAPI DeleteServiceAccount Delete /api/admin/service-account/{id} Delete a service account.
ServiceAccountsAPI DeleteServiceAccountToken Delete /api/admin/service-account/{id}/token/{tokenId} Delete a token for a service account.
ServiceAccountsAPI GetServiceAccountTokens Get /api/admin/service-account/{id}/token List all tokens for a service account.
ServiceAccountsAPI GetServiceAccounts Get /api/admin/service-account List service accounts.
ServiceAccountsAPI UpdateServiceAccount Put /api/admin/service-account/{id} Update a service account.
UsersAPI CreateRole Post /api/admin/roles Create a new role
UsersAPI CreateUser Post /api/admin/user-admin Create a new user
UsersAPI DeleteRole Delete /api/admin/roles/{roleId} Delete a custom role
UsersAPI DeleteUser Delete /api/admin/user-admin/{id} Delete a user
UsersAPI GetRoleById Get /api/admin/roles/{roleId} Get a single role
UsersAPI GetRoles Get /api/admin/roles Get a list of roles
UsersAPI GetUser Get /api/admin/user-admin/{id} Get user
UsersAPI UpdateRole Put /api/admin/roles/{roleId} Update a role
UsersAPI UpdateUser Put /api/admin/user-admin/{id} Update a user

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

apiKey

  • 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(),
		client.ContextAPIKeys,
		map[string]client.APIKey{
			"Authorization": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

bearerToken

  • Type: HTTP Bearer token authentication

Example

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