openapi

Documentation

Overview

Package openapi contains *client* code that has been auto-generated by OpenAPI generator and sends events to an external handler as specified in the OpenAPI specification included in /api.

Index

• Variables
• func CacheExpires(r *http.Response) time.Time
• type APIClient
  • func NewAPIClient(cfg *Configuration) *APIClient
  • func (c *APIClient) ChangeBasePath(path string)
  • func (c *APIClient) GetConfig() *Configuration
• type APIKey
• type APIResponse
  • func NewAPIResponse(r *http.Response) *APIResponse
  • func NewAPIResponseWithError(errorMessage string) *APIResponse
• type BasicAuth
• type Configuration
  • func NewConfiguration() *Configuration
  • func (c *Configuration) AddDefaultHeader(key string, value string)
  • func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)
• type Errors
• type Event
• type EventsApiService
  • func (a *EventsApiService) SendEvents(ctx _context.Context, event []Event) (Response, *_nethttp.Response, error)
• type GenericOpenAPIError
  • func (e GenericOpenAPIError) Body() []byte
  • func (e GenericOpenAPIError) Error() string
  • func (e GenericOpenAPIError) Model() interface{}
• type Metadata
• type ResourceResponse
• type Response
• type ServerConfiguration
• type ServerVariable
• type Service

Variables

var (
	// ContextOAuth2 takes an 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 {
	EventsApi *EventsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the CN-WAN Reader API API v1.0.0 beta 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)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

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 OpenAPI 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:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

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 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"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader

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

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

type Errors

type Errors struct {
	// A list of errors occurred, if any.
	Errors []ResourceResponse `json:"errors,omitempty"`
}

Errors struct for Errors

type Event

type Event struct {
	// The event that occurred
	Event   string  `json:"event,omitempty"`
	Service Service `json:"service"`
}

Event struct for Event

type EventsApiService

type EventsApiService service

EventsApiService EventsApi service

func (*EventsApiService) SendEvents

func (a *EventsApiService) SendEvents(ctx _context.Context, event []Event) (Response, *_nethttp.Response, error)

SendEvents Last observed events

• @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
• @param event List of observed events

@return Response

type GenericOpenAPIError

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

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

func (GenericOpenAPIError) Body

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error

func (e GenericOpenAPIError) Error() string

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

func (GenericOpenAPIError) Model

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type Metadata

type Metadata struct {
	// The name of the key in the metadata, if present in the object. Included only if required as argument in the CN-WAN Reader.
	Key string `json:"key"`
	// The observed value of this key in the metadata.
	Value string `json:"value"`
}

Metadata The metadata observed. The list only includes the ones that have been included in the command line arguments of the CN-WAN Reader.

type ResourceResponse

type ResourceResponse struct {
	// The HTTP status code.
	Status int32 `json:"status,omitempty"`
	// The name of the resource that triggered this error.
	Resource string `json:"resource,omitempty"`
	// A short title describing the error.
	Title string `json:"title"`
	// Additional information about the error.
	Description string `json:"description"`
}

ResourceResponse Information about the error occurred with the resource.

type Response

type Response struct {
	// The HTTP status code.
	Status int32 `json:"status,omitempty"`
	// The name of the resource that triggered this error.
	Resource string `json:"resource,omitempty"`
	// A short title describing the error.
	Title string `json:"title"`
	// Additional information about the error.
	Description string `json:"description"`
	// A list of errors occurred, if any.
	Errors []ResourceResponse `json:"errors,omitempty"`
}

Response Response returned.

type ServerConfiguration

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type Service

type Service struct {
	// The observed name of the endpoint.
	Name string `json:"name"`
	// The observed IP address of the endpoint. Can be IPv4 or IPv6.
	Address string `json:"address"`
	// The observed port of the endpoint.
	Port     int32      `json:"port"`
	Metadata []Metadata `json:"metadata,omitempty"`
}

Service The subject of this event