Categorygithub.com/kubeslice/stackpathpkgcdn
package
0.1.0
Repository: https://github.com/kubeslice/stackpath.git
Documentation: pkg.go.dev
Overview
Dependencies
22
Dependents
0

# README

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

ClassMethodHTTP requestDescription
ConfigurationApiConnectScopeToOriginPost /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/originsConnect an origin to a scope
ConfigurationApiCreateScopePost /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopesCreate a scope
ConfigurationApiCreateScopeHostnamePost /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/hostnamesAdd a scope hostname
ConfigurationApiDeleteScopeDelete /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}Delete a scope
ConfigurationApiDeleteScopeHostnameDelete /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/hostnames/{domain}Delete a scope hostname
ConfigurationApiDisconnectScopeFromOriginDelete /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/origins/{origin_id}Delete a scope origin
ConfigurationApiGetScopeConfigurationGet /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/configurationGet a scope's configuraiton
ConfigurationApiGetScopeHostnamesGet /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/hostnamesGet all scope hostnames
ConfigurationApiGetScopeOriginsGet /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/originsGet all scope origins
ConfigurationApiGetSiteDnsTargetsGet /cdn/v1/stacks/{stack_id}/sites/{site_id}/dns/targetsGet CNAME targets
ConfigurationApiGetSiteScopesGet /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopesGet all scopes
ConfigurationApiUpdateScopeConfigurationPatch /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/configurationUpdate a scope's configuration
EdgeRulesApiCreateScopeRulePost /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/rulesCreate an EdgeRule
EdgeRulesApiDeleteScopeRuleDelete /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/rules/{rule_id}Delete an EdgeRule
EdgeRulesApiGetScopeRuleGet /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/rules/{rule_id}Get an EdgeRule
EdgeRulesApiGetScopeRuleConfigurationGet /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/rules/{rule_id}/configurationGet an EdgeRule's configuration
EdgeRulesApiGetScopeRulesGet /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/rulesGet all EdgeRules
EdgeRulesApiUpdateScopeRuleConfigurationPatch /cdn/v1/stacks/{stack_id}/sites/{site_id}/scopes/{scope_id}/rules/{rule_id}/configurationUpdate an EdgeRule's configuration
InfrastructureApiGetCDNIPsGet /cdn/v1/ipsGet IP addresses
InfrastructureApiGetClosestPopsGet /cdn/v1/pops/closestGet POP performance
InfrastructureApiGetPopsGet /cdn/v1/popsGet points of presence
InfrastructureApiScanOriginPost /cdn/v1/origins/scanScan an origin
MetricsApiGetMetricsGet /cdn/v1/stacks/{stack_id}/metricsGet metrics
PurgeContentApiGetPurgeStatusGet /cdn/v1/stacks/{stack_id}/purge/{purge_id}Get purge status
PurgeContentApiPurgeContentPost /cdn/v1/stacks/{stack_id}/purgePurge content
SSLApiConnectSiteToCertificatePut /cdn/v1/stacks/{stack_id}/sites/{site_id}/certificates/{certificate_id}Get a site's certificate
SSLApiCreateCertificatePost /cdn/v1/stacks/{stack_id}/certificatesAdd a certificate
SSLApiDeleteCertificateDelete /cdn/v1/stacks/{stack_id}/certificates/{certificate_id}Delete a certificate
SSLApiGetCertificateGet /cdn/v1/stacks/{stack_id}/certificates/{certificate_id}Get a certificate
SSLApiGetCertificateSitesGet /cdn/v1/stacks/{stack_id}/certificates/{certificate_id}/sitesGet sites associated with a certificate
SSLApiGetCertificateVerificationDetailsGet /cdn/v1/stacks/{stack_id}/certificates/{certificate_id}/verification_detailsGet verification details
SSLApiGetCertificatesGet /cdn/v1/stacks/{stack_id}/certificatesGet all certificates
SSLApiGetSiteCertificatesGet /cdn/v1/stacks/{stack_id}/sites/{site_id}/certificatesGet all site certificates
SSLApiRenewCertificatePost /cdn/v1/stacks/{stack_id}/certificates/{certificate_id}/renewRenew a certificate
SSLApiRequestCertificatePost /cdn/v1/stacks/{stack_id}/sites/{site_id}/certificates/requestRequest a free certificate
SSLApiUpdateCertificatePut /cdn/v1/stacks/{stack_id}/certificates/{certificate_id}Update a certificate
SSLApiUpdateSiteCertificateHostsPut /cdn/v1/stacks/{stack_id}/sites/{site_id}/certificates/{certificate_id}/hostsUpdate SAN hosts
ServerlessScriptingApiCreateSiteScriptPost /cdn/v1/stacks/{stack_id}/sites/{site_id}/scriptsCreate a serverless script
ServerlessScriptingApiDeleteSiteScriptDelete /cdn/v1/stacks/{stack_id}/sites/{site_id}/scripts/{script_id}Delete a serverless script
ServerlessScriptingApiGetSiteScriptGet /cdn/v1/stacks/{stack_id}/sites/{site_id}/scripts/{script_id}Get a serverless script
ServerlessScriptingApiGetSiteScript2Get /cdn/v1/stacks/{stack_id}/sites/{site_id}/scripts/{script_id}/{script_version}Get a serverless script version
ServerlessScriptingApiGetSiteScriptsGet /cdn/v1/stacks/{stack_id}/sites/{site_id}/scriptsGet all serverless scripts
ServerlessScriptingApiUpdateSiteScriptPatch /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