Skip to content

Latest commit

 

History

History
293 lines (246 loc) · 16.8 KB

README.md

File metadata and controls

293 lines (246 loc) · 16.8 KB

Go API client for sites

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

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
DeliveryDomainsApi CreateSiteDeliveryDomain Post /delivery/v1/stacks/{stack_id}/sites/{site_id}/delivery_domains Add a delivery domain to a site
DeliveryDomainsApi DeleteSiteDeliveryDomain Delete /delivery/v1/stacks/{stack_id}/sites/{site_id}/delivery_domains/{domain} Remove a delivery domain from a site
DeliveryDomainsApi GetSiteDeliveryDomains2 Get /delivery/v1/stacks/{stack_id}/sites/{site_id}/delivery_domains Retrieve the delivery domains configured on a site
MetricsApi GetMetrics Get /delivery/v1/stacks/{stack_id}/metrics Get metrics
OriginsApi ConnectScopeToOrigin Post /delivery/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/origins Connect an origin to a scope
OriginsApi GetOrigin Get /delivery/v1/stacks/{stack_id}/origins/{origin_id} Get an origin
OriginsApi GetOrigins Get /delivery/v1/stacks/{stack_id}/origins Get all origins
OriginsApi GetScopeOrigins Get /delivery/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/origins Get a scope's origins
OriginsApi UpdateOrigin Patch /delivery/v1/stacks/{stack_id}/origins/{origin_id} Update an origin
SSLApi RecheckCertificateVerification Post /delivery/v1/stacks/{stack_id}/certificates/{certificate_id}/recheck Re-check certificate verification
SiteFeaturesApi DisableSiteCDN Delete /delivery/v1/stacks/{stack_id}/sites/{site_id}/cdn Disable CDN
SiteFeaturesApi DisableSiteEdgeEngine2 Delete /delivery/v1/stacks/{stack_id}/sites/{site_id}/scripting Disable serverless scripting
SiteFeaturesApi DisableSiteWAF Delete /delivery/v1/stacks/{stack_id}/sites/{site_id}/waf Disable WAF
SiteFeaturesApi EnableSiteCDN Post /delivery/v1/stacks/{stack_id}/sites/{site_id}/cdn Enable CDN
SiteFeaturesApi EnableSiteEdgeEngine2 Post /delivery/v1/stacks/{stack_id}/sites/{site_id}/scripting Enable serverless scripting
SiteFeaturesApi EnableSiteWAF Post /delivery/v1/stacks/{stack_id}/sites/{site_id}/waf Enable WAF
SitesApi CreateSite Post /delivery/v1/stacks/{stack_id}/sites Create a site
SitesApi DeleteSite Delete /delivery/v1/stacks/{stack_id}/sites/{site_id} Delete a site
SitesApi GetSite Get /delivery/v1/stacks/{stack_id}/sites/{site_id} Get a site
SitesApi GetSites Get /delivery/v1/stacks/{stack_id}/sites Get all sites

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