versions

Documentation

Overview

Package versions provides primitives to interact with the openapi HTTP API.

Code generated by github.com/do87/oapi-codegen version v0.5.1 DO NOT EDIT.

Index

• Constants
• func NewGetVersionsRequest(ctx context.Context, server string, projectID string, ...) (*http.Request, error)
• type Client
  • func NewClient(server string, httpClient common.Client) *Client
  • func (c *Client) GetVersions(ctx context.Context, projectID string, params *GetVersionsParams, ...) (*http.Response, error)
• type ClientInterface
• type ClientWithResponses
  • func NewClientWithResponses(server string, httpClient common.Client) *ClientWithResponses
  • func (c *ClientWithResponses) GetVersionsWithResponse(ctx context.Context, projectID string, params *GetVersionsParams, ...) (*GetVersionsResponse, error)
  • func (c *ClientWithResponses) ParseGetVersionsResponse(rsp *http.Response) (*GetVersionsResponse, error)
• type ClientWithResponsesInterface
• type GetVersionsParams
• type GetVersionsResponse
  • func (r GetVersionsResponse) Status() string
  • func (r GetVersionsResponse) StatusCode() int
• type InstanceError
• type InstanceGetVersionsResponse
• type RequestEditorFn

Constants

const (
	BearerAuthScopes = "BearerAuth.Scopes"
)

Functions

func NewGetVersionsRequest

func NewGetVersionsRequest(ctx context.Context, server string, projectID string, params *GetVersionsParams) (*http.Request, error)

NewGetVersionsRequest generates requests for GetVersions

Types

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client common.Client
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, httpClient common.Client) *Client

Creates a new Client, with reasonable defaults

func (*Client) GetVersions

func (c *Client) GetVersions(ctx context.Context, projectID string, params *GetVersionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// GetVersions request
	GetVersions(ctx context.Context, projectID string, params *GetVersionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, httpClient common.Client) *ClientWithResponses

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) GetVersionsWithResponse

func (c *ClientWithResponses) GetVersionsWithResponse(ctx context.Context, projectID string, params *GetVersionsParams, reqEditors ...RequestEditorFn) (*GetVersionsResponse, error)

GetVersionsWithResponse request returning *GetVersionsResponse

func (*ClientWithResponses) ParseGetVersionsResponse

func (c *ClientWithResponses) ParseGetVersionsResponse(rsp *http.Response) (*GetVersionsResponse, error)

ParseGetVersionsResponse parses an HTTP response from a GetVersionsWithResponse call

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetVersions request
	GetVersionsWithResponse(ctx context.Context, projectID string, params *GetVersionsParams, reqEditors ...RequestEditorFn) (*GetVersionsResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type GetVersionsParams

type GetVersionsParams struct {
	// InstanceID Instance ID
	InstanceID *string `form:"instanceID,omitempty" json:"instanceID,omitempty"`
}

GetVersionsParams defines parameters for GetVersions.

type GetVersionsResponse

type GetVersionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InstanceGetVersionsResponse
	JSON400      *InstanceError
	HasError     error // Aggregated error
}

func (GetVersionsResponse) Status

func (r GetVersionsResponse) Status() string

Status returns HTTPResponse.Status

func (GetVersionsResponse) StatusCode

func (r GetVersionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type InstanceError

type InstanceError struct {
	Code    *int                 `json:"code,omitempty"`
	Fields  *map[string][]string `json:"fields,omitempty"`
	Message *string              `json:"message,omitempty"`
	Type    *string              `json:"type,omitempty"`
}

InstanceError defines model for instance.Error.

type InstanceGetVersionsResponse

type InstanceGetVersionsResponse struct {
	Versions *[]string `json:"versions,omitempty"`
}

InstanceGetVersionsResponse defines model for instance.GetVersionsResponse.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function