Skip to content

README.md

Latest commit

 

History

History
355 lines (308 loc) · 23.5 KB

README.md

File metadata and controls

355 lines (308 loc) · 23.5 KB
Raw

Go API client for cdn

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

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
ConfigurationApi ConnectScopeToOrigin Post /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/origins Connect an origin to a scope
ConfigurationApi CreateScope Post /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes Create a scope
ConfigurationApi CreateScopeHostname Post /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/hostnames Add a scope hostname
ConfigurationApi DeleteScope Delete /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id} Delete a scope
ConfigurationApi DeleteScopeHostname Delete /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/hostnames/{domain} Delete a scope hostname
ConfigurationApi DisconnectScopeFromOrigin Delete /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/origins/{origin_id} Delete a scope origin
ConfigurationApi GetScopeConfiguration Get /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/configuration Get a scope's configuraiton
ConfigurationApi GetScopeHostnames Get /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/hostnames Get all scope hostnames
ConfigurationApi GetScopeOrigins Get /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/origins Get all scope origins
ConfigurationApi GetSiteDnsTargets Get /cdn/v1/stacks/{stack_id}/sites/{site_id}/dns/targets Get CNAME targets
ConfigurationApi GetSiteScopes Get /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes Get all scopes
ConfigurationApi UpdateScopeConfiguration Patch /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/configuration Update a scope's configuration
EdgeRulesApi CreateScopeRule Post /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/rules Create an EdgeRule
EdgeRulesApi DeleteScopeRule Delete /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/rules/{rule_id} Delete an EdgeRule
EdgeRulesApi GetScopeRule Get /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/rules/{rule_id} Get an EdgeRule
EdgeRulesApi GetScopeRuleConfiguration Get /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/rules/{rule_id}/configuration Get an EdgeRule's configuration
EdgeRulesApi GetScopeRules Get /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/rules Get all EdgeRules
EdgeRulesApi UpdateScopeRuleConfiguration Patch /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/rules/{rule_id}/configuration Update an EdgeRule's configuration
InfrastructureApi GetCDNIPs Get /cdn/v1/ips Get IP addresses
InfrastructureApi GetClosestPops Get /cdn/v1/pops/closest Get POP performance
InfrastructureApi GetPops Get /cdn/v1/pops Get points of presence
InfrastructureApi ScanOrigin Post /cdn/v1/origins/scan Scan an origin
MetricsApi GetMetrics Get /cdn/v1/stacks/{stack_id}/metrics Get metrics
PurgeContentApi GetPurgeStatus Get /cdn/v1/stacks/{stack_id}/purge/{purge_id} Get purge status
PurgeContentApi PurgeContent Post /cdn/v1/stacks/{stack_id}/purge Purge content
SSLApi ConnectSiteToCertificate Put /cdn/v1/stacks/{stack_id}/sites/{site_id}/certificates/{certificate_id} Get a site's certificate
SSLApi CreateCertificate Post /cdn/v1/stacks/{stack_id}/certificates Add a certificate
SSLApi DeleteCertificate Delete /cdn/v1/stacks/{stack_id}/certificates/{certificate_id} Delete a certificate
SSLApi GetCertificate Get /cdn/v1/stacks/{stack_id}/certificates/{certificate_id} Get a certificate
SSLApi GetCertificateSites Get /cdn/v1/stacks/{stack_id}/certificates/{certificate_id}/sites Get sites associated with a certificate
SSLApi GetCertificateVerificationDetails Get /cdn/v1/stacks/{stack_id}/certificates/{certificate_id}/verification_details Get verification details
SSLApi GetCertificates Get /cdn/v1/stacks/{stack_id}/certificates Get all certificates
SSLApi GetSiteCertificates Get /cdn/v1/stacks/{stack_id}/sites/{site_id}/certificates Get all site certificates
SSLApi RenewCertificate Post /cdn/v1/stacks/{stack_id}/certificates/{certificate_id}/renew Renew a certificate
SSLApi RequestCertificate Post /cdn/v1/stacks/{stack_id}/sites/{site_id}/certificates/request Request a free certificate
SSLApi UpdateCertificate Put /cdn/v1/stacks/{stack_id}/certificates/{certificate_id} Update a certificate
SSLApi UpdateSiteCertificateHosts Put /cdn/v1/stacks/{stack_id}/sites/{site_id}/certificates/{certificate_id}/hosts Update SAN hosts
ServerlessScriptingApi CreateSiteScript Post /cdn/v1/stacks/{stack_id}/sites/{site_id}/scripts Create a serverless script
ServerlessScriptingApi DeleteSiteScript Delete /cdn/v1/stacks/{stack_id}/sites/{site_id}/scripts/{script_id} Delete a serverless script
ServerlessScriptingApi GetSiteScript Get /cdn/v1/stacks/{stack_id}/sites/{site_id}/scripts/{script_id} Get a serverless script
ServerlessScriptingApi GetSiteScript2 Get /cdn/v1/stacks/{stack_id}/sites/{site_id}/scripts/{script_id}/{script_version} Get a serverless script version
ServerlessScriptingApi GetSiteScripts Get /cdn/v1/stacks/{stack_id}/sites/{site_id}/scripts Get all serverless scripts
ServerlessScriptingApi UpdateSiteScript Patch /cdn/v1/stacks/{stack_id}/sites/{site_id}/scripts/{script_id} Update a serverless script

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