swagger

package module
v0.0.0-...-b55e013 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 6, 2023 License: Apache-2.0 Imports: 21 Imported by: 3

README

Go API client for swagger

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 1..1
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to /

Class Method HTTP request Description
TopologyApi TopologyQuery Get /api/topology Topology query

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation

Overview

* Canary Checker API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1..1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Canary Checker API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1..1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Canary Checker API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1..1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Canary Checker API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1..1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Canary Checker API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1..1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Canary Checker API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1..1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Canary Checker API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1..1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Canary Checker API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1..1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Canary Checker API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1..1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Canary Checker API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1..1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Canary Checker API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1..1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Canary Checker API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1..1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* Canary Checker API * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 1..1 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	TopologyApi *TopologyApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Canary Checker API API v1..1 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Check 

type Check struct {
	CanaryId      string        `json:"canary_id,omitempty"`
	CanaryName    string        `json:"canary_name,omitempty"`
	CheckStatuses []CheckStatus `json:"checkStatuses,omitempty"`
	CreatedAt     string        `json:"createdAt,omitempty"`
	DeletedAt     string        `json:"deletedAt,omitempty"`
	Description   string        `json:"description,omitempty"`
	DisplayType   string        `json:"displayType,omitempty"`
	Icon          string        `json:"icon,omitempty"`
	Id            string        `json:"id,omitempty"`
	Labels        *interface{}  `json:"labels,omitempty"`
	LastRuntime   string        `json:"lastRuntime,omitempty"`
	Latency       *Latency      `json:"latency,omitempty"`
	Name          string        `json:"name,omitempty"`
	Namespace     string        `json:"namespace,omitempty"`
	NextRuntime   string        `json:"nextRuntime,omitempty"`
	Owner         string        `json:"owner,omitempty"`
	Severity      string        `json:"severity,omitempty"`
	Status        string        `json:"status,omitempty"`
	Type_         string        `json:"type,omitempty"`
	UpdatedAt     string        `json:"updatedAt,omitempty"`
	Uptime        *Uptime       `json:"uptime,omitempty"`
}

type CheckStatus 

type CheckStatus struct {
	Duration int32  `json:"duration,omitempty"`
	Error_   string `json:"error,omitempty"`
	Invalid  bool   `json:"invalid,omitempty"`
	Message  string `json:"message,omitempty"`
	Status   bool   `json:"status,omitempty"`
	Time     string `json:"time,omitempty"`
}

type Component 

type Component struct {
	Checks     []Check      `json:"checks,omitempty"`
	Components *[]Component `json:"components,omitempty"`
	Configs    []Config     `json:"configs,omitempty"`
	CreatedAt  string       `json:"created_at,omitempty"`
	// nolint
	ExternalId string `json:"external_id,omitempty"`
	Icon       string `json:"icon,omitempty"`
	// nolint
	Id     string       `json:"id,omitempty"`
	Labels *interface{} `json:"labels,omitempty"`
	// The lifecycle state of the component e.g. production, staging, dev, etc.
	Lifecycle string `json:"lifecycle,omitempty"`
	Name      string `json:"name,omitempty"`
	Namespace string `json:"namespace,omitempty"`
	Order     int32  `json:"order,omitempty"`
	Owner     string `json:"owner,omitempty"`
	// nolint
	ParentId     string     `json:"parent_id,omitempty"`
	Path         string     `json:"path,omitempty"`
	Properties   []Property `json:"properties,omitempty"`
	Schedule     string     `json:"schedule,omitempty"`
	Status       string     `json:"status,omitempty"`
	StatusReason string     `json:"status_reason,omitempty"`
	Summary      *Summary   `json:"summary,omitempty"`
	// nolint
	TopologyID   string `json:"topology_id,omitempty"`
	Text         string `json:"text,omitempty"`
	Tooltip      string `json:"tooltip,omitempty"`
	TopologyType string `json:"topology_type,omitempty"`
	// The type of component, e.g. service, API, website, library, database, etc.
	Type_     string `json:"type,omitempty"`
	UpdatedAt string `json:"updated_at,omitempty"`
}

func (Component) GetUUID 

func (c Component) GetUUID() *uuid.UUID

type Config 

type Config struct {
	Id          string       `json:"id,omitempty"`
	ConfigClass string       `json:"config_class,omitempty"`
	ExternalId  []string     `json:"external_id,omitempty"`
	Type        string       `json:"type,omitempty"`
	Name        string       `json:"name,omitempty"`
	Namespace   string       `json:"namespace,omitempty"`
	Spec        *interface{} `json:"spec,omitempty"`
}

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type GenericSwaggerError 

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type Latency 

type Latency struct {
	P95       float64 `json:"p95,omitempty"`
	P97       float64 `json:"p97,omitempty"`
	P99       float64 `json:"p99,omitempty"`
	Rolling1h float64 `json:"rolling1h,omitempty"`
}
type Link struct {
	Icon    string `json:"icon,omitempty"`
	Label   string `json:"label,omitempty"`
	Text    string `json:"text,omitempty"`
	Tooltip string `json:"tooltip,omitempty"`
	// e.g. documentation, support, playbook
	Type_ string `json:"type,omitempty"`
	Url   string `json:"url,omitempty"`
}

type Property 

type Property struct {
	Color          string `json:"color,omitempty"`
	Headline       bool   `json:"headline,omitempty"`
	Icon           string `json:"icon,omitempty"`
	Label          string `json:"label,omitempty"`
	LastTransition string `json:"lastTransition,omitempty"`
	Links          []Link `json:"links,omitempty"`
	Max            int32  `json:"max,omitempty"`
	Min            int32  `json:"min,omitempty"`
	Name           string `json:"name,omitempty"`
	Order          int32  `json:"order,omitempty"`
	Status         string `json:"status,omitempty"`
	// Either text or value is required, but not both.
	Text    string `json:"text,omitempty"`
	Tooltip string `json:"tooltip,omitempty"`
	Type_   string `json:"type,omitempty"`
	// e.g. milliseconds, bytes, millicores, epoch etc.
	Unit  string `json:"unit,omitempty"`
	Value int32  `json:"value,omitempty"`
}

type Summary 

type Summary struct {
	Healthy   int32 `json:"healthy,omitempty"`
	Info      int32 `json:"info,omitempty"`
	Unhealthy int32 `json:"unhealthy,omitempty"`
	Warning   int32 `json:"warning,omitempty"`
}

type TopologyApiService 

type TopologyApiService service

func (*TopologyApiService) TopologyQuery 

func (a *TopologyApiService) TopologyQuery(ctx context.Context, localVarOptionals *TopologyApiTopologyQueryOpts) ([]Component, *http.Response, error)

type TopologyApiTopologyQueryOpts 

type TopologyApiTopologyQueryOpts struct {
	Id          optional.String
	TopologyId  optional.String
	ComponentId optional.String
	Owner       optional.String
	Status      optional.String
	Types       optional.String
	Flatten     optional.String
}

type Uptime 

type Uptime struct {
	Failed int32   `json:"failed,omitempty"`
	P100   float64 `json:"p100,omitempty"`
	Passed int32   `json:"passed,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.