Go API client for openapi

The SaladCloud 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: 1.0.0-alpha.56
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://support.salad.com

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/GIT_USER_ID/GIT_REPO_ID"

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 https://api.salad.com/api/public

Class	Method	HTTP request	Description
ContainerGroupsAPI	ContainerGroupInstanceReallocate	Post /organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/instances/{machine_id}/reallocate	Reallocate container group instance to another node
ContainerGroupsAPI	ContainerGroupInstanceRecreate	Post /organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/instances/{machine_id}/recreate	Recreate container on a node
ContainerGroupsAPI	ContainerGroupInstanceRestart	Post /organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/instances/{machine_id}/restart	Restart container on a node
ContainerGroupsAPI	CreateContainerGroup	Post /organizations/{organization_name}/projects/{project_name}/containers	Create a Container Group
ContainerGroupsAPI	DeleteContainerGroup	Delete /organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}	Delete a Container Group
ContainerGroupsAPI	GetContainerGroup	Get /organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}	Get a Container Group
ContainerGroupsAPI	ListContainerGroupInstances	Get /organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/instances	List Container Group Instances
ContainerGroupsAPI	ListContainerGroups	Get /organizations/{organization_name}/projects/{project_name}/containers	List Container Groups
ContainerGroupsAPI	RestartContainerGroup	Post /organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/restart	Restart a Container Group
ContainerGroupsAPI	StartContainerGroup	Post /organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/start	Start a Container Group
ContainerGroupsAPI	StopContainerGroup	Post /organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/stop	Stop a Container Group
ContainerGroupsAPI	UpdateContainerGroup	Patch /organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}	Update a Container Group
OrganizationDataAPI	ListGpuClasses	Get /organizations/{organization_name}/gpu-classes	List the GPU Classes
QuotasAPI	GetQuotas	Get /organizations/{organization_name}/quotas	Get Quotas
RecipeDeploymentsAPI	CreateRecipeDeployment	Post /organizations/{organization_name}/projects/{project_name}/recipe-deployments	Create a Recipe Deployment
RecipeDeploymentsAPI	DeleteRecipeDeployment	Delete /organizations/{organization_name}/projects/{project_name}/recipe-deployments/{recipe_deployment_name}	Delete a Recipe Deployment
RecipeDeploymentsAPI	GetRecipeDeployment	Get /organizations/{organization_name}/projects/{project_name}/recipe-deployments/{recipe_deployment_name}	Get a Recipe Deployment
RecipeDeploymentsAPI	ListRecipeDeploymentInstances	Get /organizations/{organization_name}/projects/{project_name}/recipe-deployments/{recipe_deployment_name}/instances	List Recipe Deployment Instances
RecipeDeploymentsAPI	ListRecipeDeployments	Get /organizations/{organization_name}/projects/{project_name}/recipe-deployments	List Recipe Deployments
RecipeDeploymentsAPI	RestartDeployedRecipe	Post /organizations/{organization_name}/projects/{project_name}/recipe-deployments/{recipe_deployment_name}/restart	Restart a Deployed Recipe
RecipeDeploymentsAPI	StartDeployedRecipe	Post /organizations/{organization_name}/projects/{project_name}/recipe-deployments/{recipe_deployment_name}/start	Start a Deployed Recipe
RecipeDeploymentsAPI	StopDeployedRecipe	Post /organizations/{organization_name}/projects/{project_name}/recipe-deployments/{recipe_deployment_name}/stop	Stop a Deployed Recipe
RecipeDeploymentsAPI	UpdateRecipeDeployment	Patch /organizations/{organization_name}/projects/{project_name}/recipe-deployments/{recipe_deployment_name}	Update a Recipe Deployment
RecipesAPI	GetRecipe	Get /organizations/{organization_name}/recipes/{recipe_name}	Get a Recipe
RecipesAPI	ListRecipes	Get /organizations/{organization_name}/recipes	List Recipes

Documentation For Models

• Container
• ContainerGroup
• ContainerGroupInstanceStatusCount
• ContainerGroupInstances
• ContainerGroupInstancesInstancesInner
• ContainerGroupList
• ContainerGroupNetworking
• ContainerGroupProbe
• ContainerGroupProbeExec
• ContainerGroupProbeGrpc
• ContainerGroupProbeHttp
• ContainerGroupProbeTcp
• ContainerGroupState
• ContainerGroupStatus
• ContainerGroupsQuotas
• ContainerLogging
• ContainerLoggingNewRelic
• ContainerLoggingSplunk
• ContainerLoggingTcp
• ContainerNetworkingProtocol
• ContainerProbeHttpScheme
• ContainerResourceRequirements
• ContainerRestartPolicy
• CountryCode
• CreateContainer
• CreateContainerGroup
• CreateContainerGroupNetworking
• CreateContainerGroupProblemType
• CreateContainerRegistryAuthentication
• CreateContainerRegistryAuthenticationAwsEcr
• CreateContainerRegistryAuthenticationBasic
• CreateContainerRegistryAuthenticationDockerHub
• CreateContainerRegistryAuthenticationGcpGcr
• CreateRecipeDeployment
• CreateRecipeDeploymentProblemType
• CreateRecipeNetworking
• DeleteContainerGroupProblemType
• DeleteRecipeDeploymentProblemType
• GetContainerGroupProblemType
• GetRecipeDeploymentProblemType
• GetRecipeProblemType
• GpuClass
• GpuClassesList
• HttpHeadersInner
• ListContainerGroupsProblemType
• ListGpuClassesProblemType
• ListRecipeDeploymentsProblemType
• ListRecipesProblemType
• ProblemDetails
• Quotas
• ReallocateContainerGroupInstanceProblemType
• Recipe
• RecipeDeployment
• RecipeDeploymentInstances
• RecipeDeploymentInstancesInstancesInner
• RecipeDeploymentList
• RecipeList
• RecipeNetworking
• RecipeNetworkingProtocol
• RecipeResources
• RecipesQuotas
• RecreateContainerGroupInstanceProblemType
• RestartContainerGroupInstanceProblemType
• RestartContainerGroupProblemType
• RestartRecipeDeploymentProblemType
• StartContainerGroupProblemType
• StartRecipeDeploymentProblemType
• StopContainerGroupProblemType
• StopRecipeDeploymentProblemType
• UpdateContainerGroup
• UpdateContainerGroupProblemType
• UpdateRecipeDeployment
• UpdateRecipeDeploymentProblemType

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: Salad-Api-Key
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Salad-Api-Key and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		sw.ContextAPIKeys,
		map[string]sw.APIKey{
			"Salad-Api-Key": {Key: "API_KEY_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

[email protected]