Provides programmatic interface for projects within QuantCDN
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.2.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
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/quantcdn/quant-admin-go"
To use a proxy, set the environment variable HTTP_PROXY
:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
Default configuration comes with Servers
field that contains server objects as defined in the OpenAPI specification.
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 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.
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",
},
})
All URIs are relative to https://dashboard.quantcdn.io/api/v1
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultApi | CreateDomain | Post /domain/create | Create domaim |
DefaultApi | CreateProject | Post /project/create | Create project |
DefaultApi | DeleteDomain | Delete /domain/delete | Delete domain |
DefaultApi | DeleteProject | Delete /project/delete | Delete project |
DefaultApi | EditProject | Patch /project/edit | Edit project |
DefaultApi | GetCrawlRun | Get /crawl/runs/{runId} | Get crawl run status |
DefaultApi | GetCrawlers | Get /crawl/configs | Get crawl configs |
DefaultApi | GetOrganisations | Get /organisations | Get organisations |
DefaultApi | GetProject | Get /project | Get project |
DefaultApi | GetProjects | Get /projects | Get projects |
DefaultApi | RunCrawler | Post /crawl/run/{uuid} | Run crawl config |
DefaultApi | SslRenewDomain | Post /domain/ssl-renew | Renew domain SSL certificate |
- CrawlerConfig
- CrawlerConfigResponse
- CrawlerConfigResponseData
- DomainCreate
- DomainSSLRenew
- Error
- GetCrawlRun200Response
- GetCrawlRun200ResponseData
- InlineResponse200
- InlineResponse200Data
- Message
- MessageData
- Organisation
- Organisations
- OrganisationsData
- Project
- ProjectConfig
- ProjectCreate
- ProjectDomains
- ProjectEdit
- ProjectResponse
- ProjectResponseData
- Projects
- ProjectsData
- ProjectsDataProjects
- RunCrawlerRequest
Authentication schemes defined for the API:
- Type: HTTP Bearer token authentication
Example
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)
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