Skip to content

Latest commit

 

History

History
244 lines (197 loc) · 12.1 KB

README.md

File metadata and controls

244 lines (197 loc) · 12.1 KB

Go API client for edge_compute

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
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientExperimentalCodegen For more information, please visit https://support.stackpath.com/

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 "./edge_compute"

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 identifield 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://gateway.stackpath.com

Class Method HTTP request Description
InfrastructureApi GetLocations Get /workload/v1/locations Get compute locations
InstanceLogsApi GetLogs Get /workload/v1/stacks/{stack_id}/workloads/{workload_id}/instances/{instance_name}/logs Get log stream
InstancesApi GetWorkloadInstance Get /workload/v1/stacks/{stack_id}/workloads/{workload_id}/instances/{instance_name} Get a workload instance
InstancesApi GetWorkloadInstances Get /workload/v1/stacks/{stack_id}/workloads/{workload_id}/instances Get all workload instances
InstancesApi RestartInstance Post /workload/v1/stacks/{stack_id}/workloads/{workload_id}/instances/{instance_name}/power/restart Restart a workload instance
MetricsApi GetMetrics Get /workload/v1/stacks/{stack_id}/metrics Get metrics
VirtualMachineImagesApi CreateImage Post /workload/v1/stacks/{stack_id}/images/{image_family}/{image_tag} Create an image
VirtualMachineImagesApi DeleteImage Delete /workload/v1/stacks/{stack_id}/images/{image_family}/{image_tag} Delete an image
VirtualMachineImagesApi DeleteImagesForFamily Delete /workload/v1/stacks/{stack_id}/images/{image_family} Delete a family's images
VirtualMachineImagesApi GetImage Get /workload/v1/stacks/{stack_id}/images/{image_family}/{image_tag} Get an image
VirtualMachineImagesApi GetImages Get /workload/v1/stacks/{stack_id}/images Get all images
VirtualMachineImagesApi GetImagesForFamily Get /workload/v1/stacks/{stack_id}/images/{image_family} Get a family's images
VirtualMachineImagesApi UpdateImage Patch /workload/v1/stacks/{stack_id}/images/{image_family}/{image_tag} Update an image
VirtualMachineImagesApi UpdateImageDeprecation Put /workload/v1/stacks/{stack_id}/images/{image_family}/{image_tag}/deprecation Update deprecation settings
WorkloadsApi CreateWorkload Post /workload/v1/stacks/{stack_id}/workloads Create a workload
WorkloadsApi DeleteWorkload Delete /workload/v1/stacks/{stack_id}/workloads/{workload_id} Delete a workload
WorkloadsApi GetWorkload Get /workload/v1/stacks/{stack_id}/workloads/{workload_id} Get a workload
WorkloadsApi GetWorkloads Get /workload/v1/stacks/{stack_id}/workloads Get all workloads
WorkloadsApi UpdateWorkload Patch /workload/v1/stacks/{stack_id}/workloads/{workload_id} Update a workload

Documentation For Models

Documentation For Authorization

oauth2

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • 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