parameters

package
v1.9.2 Latest Latest
Warning

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

 Go to latest Published: Oct 22, 2019 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Package parameters provides primitives to interact the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetSwagger 

func GetSwagger() (*openapi3.Swagger, error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file.

func NewGetContentObjectRequest 

func NewGetContentObjectRequest(server string, param ComplexObject) (*http.Request, error)

NewGetContentObjectRequest generates requests for GetContentObject

func NewGetCookieRequest 

func NewGetCookieRequest(server string, params *GetCookieParams) (*http.Request, error)

NewGetCookieRequest generates requests for GetCookie

func NewGetHeaderRequest 

func NewGetHeaderRequest(server string, params *GetHeaderParams) (*http.Request, error)

NewGetHeaderRequest generates requests for GetHeader

func NewGetLabelExplodeArrayRequest 

func NewGetLabelExplodeArrayRequest(server string, param []int32) (*http.Request, error)

NewGetLabelExplodeArrayRequest generates requests for GetLabelExplodeArray

func NewGetLabelExplodeObjectRequest 

func NewGetLabelExplodeObjectRequest(server string, param Object) (*http.Request, error)

NewGetLabelExplodeObjectRequest generates requests for GetLabelExplodeObject

func NewGetLabelNoExplodeArrayRequest 

func NewGetLabelNoExplodeArrayRequest(server string, param []int32) (*http.Request, error)

NewGetLabelNoExplodeArrayRequest generates requests for GetLabelNoExplodeArray

func NewGetLabelNoExplodeObjectRequest 

func NewGetLabelNoExplodeObjectRequest(server string, param Object) (*http.Request, error)

NewGetLabelNoExplodeObjectRequest generates requests for GetLabelNoExplodeObject

func NewGetMatrixExplodeArrayRequest 

func NewGetMatrixExplodeArrayRequest(server string, id []int32) (*http.Request, error)

NewGetMatrixExplodeArrayRequest generates requests for GetMatrixExplodeArray

func NewGetMatrixExplodeObjectRequest 

func NewGetMatrixExplodeObjectRequest(server string, id Object) (*http.Request, error)

NewGetMatrixExplodeObjectRequest generates requests for GetMatrixExplodeObject

func NewGetMatrixNoExplodeArrayRequest 

func NewGetMatrixNoExplodeArrayRequest(server string, id []int32) (*http.Request, error)

NewGetMatrixNoExplodeArrayRequest generates requests for GetMatrixNoExplodeArray

func NewGetMatrixNoExplodeObjectRequest 

func NewGetMatrixNoExplodeObjectRequest(server string, id Object) (*http.Request, error)

NewGetMatrixNoExplodeObjectRequest generates requests for GetMatrixNoExplodeObject

func NewGetPassThroughRequest 

func NewGetPassThroughRequest(server string, param string) (*http.Request, error)

NewGetPassThroughRequest generates requests for GetPassThrough

func NewGetQueryFormRequest 

func NewGetQueryFormRequest(server string, params *GetQueryFormParams) (*http.Request, error)

NewGetQueryFormRequest generates requests for GetQueryForm

func NewGetSimpleExplodeArrayRequest 

func NewGetSimpleExplodeArrayRequest(server string, param []int32) (*http.Request, error)

NewGetSimpleExplodeArrayRequest generates requests for GetSimpleExplodeArray

func NewGetSimpleExplodeObjectRequest 

func NewGetSimpleExplodeObjectRequest(server string, param Object) (*http.Request, error)

NewGetSimpleExplodeObjectRequest generates requests for GetSimpleExplodeObject

func NewGetSimpleNoExplodeArrayRequest 

func NewGetSimpleNoExplodeArrayRequest(server string, param []int32) (*http.Request, error)

NewGetSimpleNoExplodeArrayRequest generates requests for GetSimpleNoExplodeArray

func NewGetSimpleNoExplodeObjectRequest 

func NewGetSimpleNoExplodeObjectRequest(server string, param Object) (*http.Request, error)

NewGetSimpleNoExplodeObjectRequest generates requests for GetSimpleNoExplodeObject

func NewGetSimplePrimitiveRequest 

func NewGetSimplePrimitiveRequest(server string, param int32) (*http.Request, error)

NewGetSimplePrimitiveRequest generates requests for GetSimplePrimitive

func ParsegetContentObjectResponse 

func ParsegetContentObjectResponse(rsp *http.Response) (*getContentObjectResponse, error)

ParsegetContentObjectResponse parses an HTTP response from a GetContentObjectWithResponse call

func ParsegetCookieResponse 

func ParsegetCookieResponse(rsp *http.Response) (*getCookieResponse, error)

ParsegetCookieResponse parses an HTTP response from a GetCookieWithResponse call

func ParsegetHeaderResponse 

func ParsegetHeaderResponse(rsp *http.Response) (*getHeaderResponse, error)

ParsegetHeaderResponse parses an HTTP response from a GetHeaderWithResponse call

func ParsegetLabelExplodeArrayResponse 

func ParsegetLabelExplodeArrayResponse(rsp *http.Response) (*getLabelExplodeArrayResponse, error)

ParsegetLabelExplodeArrayResponse parses an HTTP response from a GetLabelExplodeArrayWithResponse call

func ParsegetLabelExplodeObjectResponse 

func ParsegetLabelExplodeObjectResponse(rsp *http.Response) (*getLabelExplodeObjectResponse, error)

ParsegetLabelExplodeObjectResponse parses an HTTP response from a GetLabelExplodeObjectWithResponse call

func ParsegetLabelNoExplodeArrayResponse 

func ParsegetLabelNoExplodeArrayResponse(rsp *http.Response) (*getLabelNoExplodeArrayResponse, error)

ParsegetLabelNoExplodeArrayResponse parses an HTTP response from a GetLabelNoExplodeArrayWithResponse call

func ParsegetLabelNoExplodeObjectResponse 

func ParsegetLabelNoExplodeObjectResponse(rsp *http.Response) (*getLabelNoExplodeObjectResponse, error)

ParsegetLabelNoExplodeObjectResponse parses an HTTP response from a GetLabelNoExplodeObjectWithResponse call

func ParsegetMatrixExplodeArrayResponse 

func ParsegetMatrixExplodeArrayResponse(rsp *http.Response) (*getMatrixExplodeArrayResponse, error)

ParsegetMatrixExplodeArrayResponse parses an HTTP response from a GetMatrixExplodeArrayWithResponse call

func ParsegetMatrixExplodeObjectResponse 

func ParsegetMatrixExplodeObjectResponse(rsp *http.Response) (*getMatrixExplodeObjectResponse, error)

ParsegetMatrixExplodeObjectResponse parses an HTTP response from a GetMatrixExplodeObjectWithResponse call

func ParsegetMatrixNoExplodeArrayResponse 

func ParsegetMatrixNoExplodeArrayResponse(rsp *http.Response) (*getMatrixNoExplodeArrayResponse, error)

ParsegetMatrixNoExplodeArrayResponse parses an HTTP response from a GetMatrixNoExplodeArrayWithResponse call

func ParsegetMatrixNoExplodeObjectResponse 

func ParsegetMatrixNoExplodeObjectResponse(rsp *http.Response) (*getMatrixNoExplodeObjectResponse, error)

ParsegetMatrixNoExplodeObjectResponse parses an HTTP response from a GetMatrixNoExplodeObjectWithResponse call

func ParsegetPassThroughResponse 

func ParsegetPassThroughResponse(rsp *http.Response) (*getPassThroughResponse, error)

ParsegetPassThroughResponse parses an HTTP response from a GetPassThroughWithResponse call

func ParsegetQueryFormResponse 

func ParsegetQueryFormResponse(rsp *http.Response) (*getQueryFormResponse, error)

ParsegetQueryFormResponse parses an HTTP response from a GetQueryFormWithResponse call

func ParsegetSimpleExplodeArrayResponse 

func ParsegetSimpleExplodeArrayResponse(rsp *http.Response) (*getSimpleExplodeArrayResponse, error)

ParsegetSimpleExplodeArrayResponse parses an HTTP response from a GetSimpleExplodeArrayWithResponse call

func ParsegetSimpleExplodeObjectResponse 

func ParsegetSimpleExplodeObjectResponse(rsp *http.Response) (*getSimpleExplodeObjectResponse, error)

ParsegetSimpleExplodeObjectResponse parses an HTTP response from a GetSimpleExplodeObjectWithResponse call

func ParsegetSimpleNoExplodeArrayResponse 

func ParsegetSimpleNoExplodeArrayResponse(rsp *http.Response) (*getSimpleNoExplodeArrayResponse, error)

ParsegetSimpleNoExplodeArrayResponse parses an HTTP response from a GetSimpleNoExplodeArrayWithResponse call

func ParsegetSimpleNoExplodeObjectResponse 

func ParsegetSimpleNoExplodeObjectResponse(rsp *http.Response) (*getSimpleNoExplodeObjectResponse, error)

ParsegetSimpleNoExplodeObjectResponse parses an HTTP response from a GetSimpleNoExplodeObjectWithResponse call

func ParsegetSimplePrimitiveResponse 

func ParsegetSimplePrimitiveResponse(rsp *http.Response) (*getSimplePrimitiveResponse, error)

ParsegetSimplePrimitiveResponse parses an HTTP response from a GetSimplePrimitiveWithResponse call

func RegisterHandlers 

func RegisterHandlers(router runtime.EchoRouter, si ServerInterface)

RegisterHandlers adds each server route to the EchoRouter.

Types

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example.
	Server string

	// HTTP client with any customized settings, such as certificate chains.
	Client *http.Client

	// A callback for modifying requests which are generated before sending over
	// the network.
	RequestEditor RequestEditorFn

	// A callback which gets called after request finished, before any
	// deserialization steps.
	RequestCompletion RequestCompletionFn

	// List of additional interceptors, which gets called prior
	// of the RequestEditor.
	Interceptors []Interceptor
	// contains filtered or unexported fields
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(ctx context.Context, opts ...Option) (*Client, error)

NewClient creates a new Client.

func (*Client) GetContentObject 

func (c *Client) GetContentObject(ctx context.Context, param ComplexObject) (*http.Response, error)

func (*Client) GetCookie 

func (c *Client) GetCookie(ctx context.Context, params *GetCookieParams) (*http.Response, error)

func (*Client) GetHeader 

func (c *Client) GetHeader(ctx context.Context, params *GetHeaderParams) (*http.Response, error)

func (*Client) GetLabelExplodeArray 

func (c *Client) GetLabelExplodeArray(ctx context.Context, param []int32) (*http.Response, error)

func (*Client) GetLabelExplodeObject 

func (c *Client) GetLabelExplodeObject(ctx context.Context, param Object) (*http.Response, error)

func (*Client) GetLabelNoExplodeArray 

func (c *Client) GetLabelNoExplodeArray(ctx context.Context, param []int32) (*http.Response, error)

func (*Client) GetLabelNoExplodeObject 

func (c *Client) GetLabelNoExplodeObject(ctx context.Context, param Object) (*http.Response, error)

func (*Client) GetMatrixExplodeArray 

func (c *Client) GetMatrixExplodeArray(ctx context.Context, id []int32) (*http.Response, error)

func (*Client) GetMatrixExplodeObject 

func (c *Client) GetMatrixExplodeObject(ctx context.Context, id Object) (*http.Response, error)

func (*Client) GetMatrixNoExplodeArray 

func (c *Client) GetMatrixNoExplodeArray(ctx context.Context, id []int32) (*http.Response, error)

func (*Client) GetMatrixNoExplodeObject 

func (c *Client) GetMatrixNoExplodeObject(ctx context.Context, id Object) (*http.Response, error)

func (*Client) GetPassThrough 

func (c *Client) GetPassThrough(ctx context.Context, param string) (*http.Response, error)

func (*Client) GetQueryForm 

func (c *Client) GetQueryForm(ctx context.Context, params *GetQueryFormParams) (*http.Response, error)

func (*Client) GetSimpleExplodeArray 

func (c *Client) GetSimpleExplodeArray(ctx context.Context, param []int32) (*http.Response, error)

func (*Client) GetSimpleExplodeObject 

func (c *Client) GetSimpleExplodeObject(ctx context.Context, param Object) (*http.Response, error)

func (*Client) GetSimpleNoExplodeArray 

func (c *Client) GetSimpleNoExplodeArray(ctx context.Context, param []int32) (*http.Response, error)

func (*Client) GetSimpleNoExplodeObject 

func (c *Client) GetSimpleNoExplodeObject(ctx context.Context, param Object) (*http.Response, error)

func (*Client) GetSimplePrimitive 

func (c *Client) GetSimplePrimitive(ctx context.Context, param int32) (*http.Response, error)

func (*Client) Intercept 

func (c *Client) Intercept(req *http.Request, ctx context.Context) error

Intercept intercepts the request, applies all registered Interceptors which are part of the client. If an Interceptor fails, the Interceptor chain will return early.

type ClientInterface 

type ClientInterface interface {

	// Intercept intercepts the request, applies all registered Interceptors
	// which are part of the client.
	// If an Interceptor fails, the Interceptor chain will return early.
	Intercept(req *http.Request, ctx context.Context) error

	// GetContentObject request
	GetContentObject(ctx context.Context, param ComplexObject) (*http.Response, error)

	// GetCookie request
	GetCookie(ctx context.Context, params *GetCookieParams) (*http.Response, error)

	// GetHeader request
	GetHeader(ctx context.Context, params *GetHeaderParams) (*http.Response, error)

	// GetLabelExplodeArray request
	GetLabelExplodeArray(ctx context.Context, param []int32) (*http.Response, error)

	// GetLabelExplodeObject request
	GetLabelExplodeObject(ctx context.Context, param Object) (*http.Response, error)

	// GetLabelNoExplodeArray request
	GetLabelNoExplodeArray(ctx context.Context, param []int32) (*http.Response, error)

	// GetLabelNoExplodeObject request
	GetLabelNoExplodeObject(ctx context.Context, param Object) (*http.Response, error)

	// GetMatrixExplodeArray request
	GetMatrixExplodeArray(ctx context.Context, id []int32) (*http.Response, error)

	// GetMatrixExplodeObject request
	GetMatrixExplodeObject(ctx context.Context, id Object) (*http.Response, error)

	// GetMatrixNoExplodeArray request
	GetMatrixNoExplodeArray(ctx context.Context, id []int32) (*http.Response, error)

	// GetMatrixNoExplodeObject request
	GetMatrixNoExplodeObject(ctx context.Context, id Object) (*http.Response, error)

	// GetPassThrough request
	GetPassThrough(ctx context.Context, param string) (*http.Response, error)

	// GetQueryForm request
	GetQueryForm(ctx context.Context, params *GetQueryFormParams) (*http.Response, error)

	// GetSimpleExplodeArray request
	GetSimpleExplodeArray(ctx context.Context, param []int32) (*http.Response, error)

	// GetSimpleExplodeObject request
	GetSimpleExplodeObject(ctx context.Context, param Object) (*http.Response, error)

	// GetSimpleNoExplodeArray request
	GetSimpleNoExplodeArray(ctx context.Context, param []int32) (*http.Response, error)

	// GetSimpleNoExplodeObject request
	GetSimpleNoExplodeObject(ctx context.Context, param Object) (*http.Response, error)

	// GetSimplePrimitive request
	GetSimplePrimitive(ctx context.Context, param int32) (*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) *ClientWithResponses

NewClientWithResponses returns a ClientWithResponses with a default Client:

func NewClientWithResponsesAndRequestEditorFunc 

func NewClientWithResponsesAndRequestEditorFunc(server string, reqEditorFn RequestEditorFn) *ClientWithResponses

NewClientWithResponsesAndRequestEditorFunc takes in a RequestEditorFn callback function and returns a ClientWithResponses with a default Client:

func (*ClientWithResponses) GetContentObjectWithResponse 

func (c *ClientWithResponses) GetContentObjectWithResponse(ctx context.Context, param ComplexObject) (*getContentObjectResponse, error)

GetContentObjectWithResponse request returning *GetContentObjectResponse

func (*ClientWithResponses) GetCookieWithResponse 

func (c *ClientWithResponses) GetCookieWithResponse(ctx context.Context, params *GetCookieParams) (*getCookieResponse, error)

GetCookieWithResponse request returning *GetCookieResponse

func (*ClientWithResponses) GetHeaderWithResponse 

func (c *ClientWithResponses) GetHeaderWithResponse(ctx context.Context, params *GetHeaderParams) (*getHeaderResponse, error)

GetHeaderWithResponse request returning *GetHeaderResponse

func (*ClientWithResponses) GetLabelExplodeArrayWithResponse 

func (c *ClientWithResponses) GetLabelExplodeArrayWithResponse(ctx context.Context, param []int32) (*getLabelExplodeArrayResponse, error)

GetLabelExplodeArrayWithResponse request returning *GetLabelExplodeArrayResponse

func (*ClientWithResponses) GetLabelExplodeObjectWithResponse 

func (c *ClientWithResponses) GetLabelExplodeObjectWithResponse(ctx context.Context, param Object) (*getLabelExplodeObjectResponse, error)

GetLabelExplodeObjectWithResponse request returning *GetLabelExplodeObjectResponse

func (*ClientWithResponses) GetLabelNoExplodeArrayWithResponse 

func (c *ClientWithResponses) GetLabelNoExplodeArrayWithResponse(ctx context.Context, param []int32) (*getLabelNoExplodeArrayResponse, error)

GetLabelNoExplodeArrayWithResponse request returning *GetLabelNoExplodeArrayResponse

func (*ClientWithResponses) GetLabelNoExplodeObjectWithResponse 

func (c *ClientWithResponses) GetLabelNoExplodeObjectWithResponse(ctx context.Context, param Object) (*getLabelNoExplodeObjectResponse, error)

GetLabelNoExplodeObjectWithResponse request returning *GetLabelNoExplodeObjectResponse

func (*ClientWithResponses) GetMatrixExplodeArrayWithResponse 

func (c *ClientWithResponses) GetMatrixExplodeArrayWithResponse(ctx context.Context, id []int32) (*getMatrixExplodeArrayResponse, error)

GetMatrixExplodeArrayWithResponse request returning *GetMatrixExplodeArrayResponse

func (*ClientWithResponses) GetMatrixExplodeObjectWithResponse 

func (c *ClientWithResponses) GetMatrixExplodeObjectWithResponse(ctx context.Context, id Object) (*getMatrixExplodeObjectResponse, error)

GetMatrixExplodeObjectWithResponse request returning *GetMatrixExplodeObjectResponse

func (*ClientWithResponses) GetMatrixNoExplodeArrayWithResponse 

func (c *ClientWithResponses) GetMatrixNoExplodeArrayWithResponse(ctx context.Context, id []int32) (*getMatrixNoExplodeArrayResponse, error)

GetMatrixNoExplodeArrayWithResponse request returning *GetMatrixNoExplodeArrayResponse

func (*ClientWithResponses) GetMatrixNoExplodeObjectWithResponse 

func (c *ClientWithResponses) GetMatrixNoExplodeObjectWithResponse(ctx context.Context, id Object) (*getMatrixNoExplodeObjectResponse, error)

GetMatrixNoExplodeObjectWithResponse request returning *GetMatrixNoExplodeObjectResponse

func (*ClientWithResponses) GetPassThroughWithResponse 

func (c *ClientWithResponses) GetPassThroughWithResponse(ctx context.Context, param string) (*getPassThroughResponse, error)

GetPassThroughWithResponse request returning *GetPassThroughResponse

func (*ClientWithResponses) GetQueryFormWithResponse 

func (c *ClientWithResponses) GetQueryFormWithResponse(ctx context.Context, params *GetQueryFormParams) (*getQueryFormResponse, error)

GetQueryFormWithResponse request returning *GetQueryFormResponse

func (*ClientWithResponses) GetSimpleExplodeArrayWithResponse 

func (c *ClientWithResponses) GetSimpleExplodeArrayWithResponse(ctx context.Context, param []int32) (*getSimpleExplodeArrayResponse, error)

GetSimpleExplodeArrayWithResponse request returning *GetSimpleExplodeArrayResponse

func (*ClientWithResponses) GetSimpleExplodeObjectWithResponse 

func (c *ClientWithResponses) GetSimpleExplodeObjectWithResponse(ctx context.Context, param Object) (*getSimpleExplodeObjectResponse, error)

GetSimpleExplodeObjectWithResponse request returning *GetSimpleExplodeObjectResponse

func (*ClientWithResponses) GetSimpleNoExplodeArrayWithResponse 

func (c *ClientWithResponses) GetSimpleNoExplodeArrayWithResponse(ctx context.Context, param []int32) (*getSimpleNoExplodeArrayResponse, error)

GetSimpleNoExplodeArrayWithResponse request returning *GetSimpleNoExplodeArrayResponse

func (*ClientWithResponses) GetSimpleNoExplodeObjectWithResponse 

func (c *ClientWithResponses) GetSimpleNoExplodeObjectWithResponse(ctx context.Context, param Object) (*getSimpleNoExplodeObjectResponse, error)

GetSimpleNoExplodeObjectWithResponse request returning *GetSimpleNoExplodeObjectResponse

func (*ClientWithResponses) GetSimplePrimitiveWithResponse 

func (c *ClientWithResponses) GetSimplePrimitiveWithResponse(ctx context.Context, param int32) (*getSimplePrimitiveResponse, error)

GetSimplePrimitiveWithResponse request returning *GetSimplePrimitiveResponse

type ComplexObject 

type ComplexObject struct {
	Id     string `json:"Id"`
	Object Object `json:"Object"`
}

ComplexObject defines model for ComplexObject.

type GetCookieParams 

type GetCookieParams struct {

	// primitive
	P *int32 `json:"p,omitempty"`

	// primitive
	Ep *int32 `json:"ep,omitempty"`

	// exploded array
	Ea *[]int32 `json:"ea,omitempty"`

	// array
	A *[]int32 `json:"a,omitempty"`

	// exploded object
	Eo *Object `json:"eo,omitempty"`

	// object
	O *Object `json:"o,omitempty"`

	// complex object
	Co *ComplexObject `json:"co,omitempty"`
}

GetCookieParams defines parameters for GetCookie.

type GetHeaderParams 

type GetHeaderParams struct {

	// primitive
	XPrimitive *int32 `json:"X-Primitive,omitempty"`

	// primitive
	XPrimitiveExploded *int32 `json:"X-Primitive-Exploded,omitempty"`

	// exploded array
	XArrayExploded *[]int32 `json:"X-Array-Exploded,omitempty"`

	// array
	XArray *[]int32 `json:"X-Array,omitempty"`

	// exploded object
	XObjectExploded *Object `json:"X-Object-Exploded,omitempty"`

	// object
	XObject *Object `json:"X-Object,omitempty"`

	// complex object
	XComplexObject *ComplexObject `json:"X-Complex-Object,omitempty"`
}

GetHeaderParams defines parameters for GetHeader.

type GetQueryFormParams 

type GetQueryFormParams struct {

	// exploded array
	Ea *[]int32 `json:"ea,omitempty"`

	// array
	A *[]int32 `json:"a,omitempty"`

	// exploded object
	Eo *Object `json:"eo,omitempty"`

	// object
	O *Object `json:"o,omitempty"`

	// exploded primitive
	Ep *int32 `json:"ep,omitempty"`

	// primitive
	P *int32 `json:"p,omitempty"`

	// complex object
	Co *ComplexObject `json:"co,omitempty"`
}

GetQueryFormParams defines parameters for GetQueryForm.

type Interceptor 

type Interceptor interface {
	// Intercept intercepts a request and can fail with an error.
	Intercept(req *http.Request, ctx context.Context) error
}

Interceptor allows intercepting requests.

type InterceptorFn 

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

InterceptorFn allows intercepting requests and can be used as an adapter to a Interceptor.

func (InterceptorFn) Intercept 

func (f InterceptorFn) Intercept(req *http.Request, ctx context.Context) error

InterceptorFn is an adapter to allow the use of ordinary functions as Interceptors.

type Object 

type Object struct {
	FirstName string `json:"firstName"`
	Role      string `json:"role"`
}

Object defines model for Object.

type Option 

type Option func(*Client) error

Option allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) Option

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(httpClient *http.Client) Option

WithHTTPClient allows overriding the default httpClient, which is automatically created. This is useful for tests.

func WithIdleTimeout 

func WithIdleTimeout(timeout time.Duration) Option

WithIdleTimeout overrides the timeout of idle connections.

func WithInterceptors 

func WithInterceptors(interceptors ...Interceptor) Option

WithInterceptors allows adding 0..N interceptors, which get called in serial order prior of calling the RequestEditor before finally making the request. Use this function to attach authentication mechanisms.

func WithMaxIdleConnections 

func WithMaxIdleConnections(maxIdleConns uint) Option

WithMaxIdleConnections overrides the amount of idle connections of the underlying http-client.

func WithRequestCompletionFn 

func WithRequestCompletionFn(fn RequestCompletionFn) Option

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

func WithRequestEditorFn 

func WithRequestEditorFn(fn RequestEditorFn) Option

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

func WithRequestTimeout 

func WithRequestTimeout(timeout time.Duration) Option

WithRequestTimeout overrides the timeout of individual requests.

func WithUserAgent 

func WithUserAgent(userAgent string) Option

WithUserAgent allows setting the userAgent

type RequestCompletionFn 

type RequestCompletionFn func(req *http.Request, resp *http.Response)

RequestCompletionFn is the function signature for the RequestCompletion callback function

type RequestEditorFn 

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

RequestEditorFn is the function signature for the RequestEditor callback function

type ServerInterface 

type ServerInterface interface {
	// (GET /contentObject/{param})
	GetContentObject(ctx echo.Context, param ComplexObject) error
	// (GET /cookie)
	GetCookie(ctx echo.Context, params GetCookieParams) error
	// (GET /header)
	GetHeader(ctx echo.Context, params GetHeaderParams) error
	// (GET /labelExplodeArray/{.param*})
	GetLabelExplodeArray(ctx echo.Context, param []int32) error
	// (GET /labelExplodeObject/{.param*})
	GetLabelExplodeObject(ctx echo.Context, param Object) error
	// (GET /labelNoExplodeArray/{.param})
	GetLabelNoExplodeArray(ctx echo.Context, param []int32) error
	// (GET /labelNoExplodeObject/{.param})
	GetLabelNoExplodeObject(ctx echo.Context, param Object) error
	// (GET /matrixExplodeArray/{.id*})
	GetMatrixExplodeArray(ctx echo.Context, id []int32) error
	// (GET /matrixExplodeObject/{.id*})
	GetMatrixExplodeObject(ctx echo.Context, id Object) error
	// (GET /matrixNoExplodeArray/{.id})
	GetMatrixNoExplodeArray(ctx echo.Context, id []int32) error
	// (GET /matrixNoExplodeObject/{.id})
	GetMatrixNoExplodeObject(ctx echo.Context, id Object) error
	// (GET /passThrough/{param})
	GetPassThrough(ctx echo.Context, param string) error
	// (GET /queryForm)
	GetQueryForm(ctx echo.Context, params GetQueryFormParams) error
	// (GET /simpleExplodeArray/{param*})
	GetSimpleExplodeArray(ctx echo.Context, param []int32) error
	// (GET /simpleExplodeObject/{param*})
	GetSimpleExplodeObject(ctx echo.Context, param Object) error
	// (GET /simpleNoExplodeArray/{param})
	GetSimpleNoExplodeArray(ctx echo.Context, param []int32) error
	// (GET /simpleNoExplodeObject/{param})
	GetSimpleNoExplodeObject(ctx echo.Context, param Object) error
	// (GET /simplePrimitive/{param})
	GetSimplePrimitive(ctx echo.Context, param int32) error
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper 

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) GetContentObject 

func (w *ServerInterfaceWrapper) GetContentObject(ctx echo.Context) error

GetContentObject converts echo context to params.

func (*ServerInterfaceWrapper) GetCookie 

func (w *ServerInterfaceWrapper) GetCookie(ctx echo.Context) error

GetCookie converts echo context to params.

func (*ServerInterfaceWrapper) GetHeader 

func (w *ServerInterfaceWrapper) GetHeader(ctx echo.Context) error

GetHeader converts echo context to params.

func (*ServerInterfaceWrapper) GetLabelExplodeArray 

func (w *ServerInterfaceWrapper) GetLabelExplodeArray(ctx echo.Context) error

GetLabelExplodeArray converts echo context to params.

func (*ServerInterfaceWrapper) GetLabelExplodeObject 

func (w *ServerInterfaceWrapper) GetLabelExplodeObject(ctx echo.Context) error

GetLabelExplodeObject converts echo context to params.

func (*ServerInterfaceWrapper) GetLabelNoExplodeArray 

func (w *ServerInterfaceWrapper) GetLabelNoExplodeArray(ctx echo.Context) error

GetLabelNoExplodeArray converts echo context to params.

func (*ServerInterfaceWrapper) GetLabelNoExplodeObject 

func (w *ServerInterfaceWrapper) GetLabelNoExplodeObject(ctx echo.Context) error

GetLabelNoExplodeObject converts echo context to params.

func (*ServerInterfaceWrapper) GetMatrixExplodeArray 

func (w *ServerInterfaceWrapper) GetMatrixExplodeArray(ctx echo.Context) error

GetMatrixExplodeArray converts echo context to params.

func (*ServerInterfaceWrapper) GetMatrixExplodeObject 

func (w *ServerInterfaceWrapper) GetMatrixExplodeObject(ctx echo.Context) error

GetMatrixExplodeObject converts echo context to params.

func (*ServerInterfaceWrapper) GetMatrixNoExplodeArray 

func (w *ServerInterfaceWrapper) GetMatrixNoExplodeArray(ctx echo.Context) error

GetMatrixNoExplodeArray converts echo context to params.

func (*ServerInterfaceWrapper) GetMatrixNoExplodeObject 

func (w *ServerInterfaceWrapper) GetMatrixNoExplodeObject(ctx echo.Context) error

GetMatrixNoExplodeObject converts echo context to params.

func (*ServerInterfaceWrapper) GetPassThrough 

func (w *ServerInterfaceWrapper) GetPassThrough(ctx echo.Context) error

GetPassThrough converts echo context to params.

func (*ServerInterfaceWrapper) GetQueryForm 

func (w *ServerInterfaceWrapper) GetQueryForm(ctx echo.Context) error

GetQueryForm converts echo context to params.

func (*ServerInterfaceWrapper) GetSimpleExplodeArray 

func (w *ServerInterfaceWrapper) GetSimpleExplodeArray(ctx echo.Context) error

GetSimpleExplodeArray converts echo context to params.

func (*ServerInterfaceWrapper) GetSimpleExplodeObject 

func (w *ServerInterfaceWrapper) GetSimpleExplodeObject(ctx echo.Context) error

GetSimpleExplodeObject converts echo context to params.

func (*ServerInterfaceWrapper) GetSimpleNoExplodeArray 

func (w *ServerInterfaceWrapper) GetSimpleNoExplodeArray(ctx echo.Context) error

GetSimpleNoExplodeArray converts echo context to params.

func (*ServerInterfaceWrapper) GetSimpleNoExplodeObject 

func (w *ServerInterfaceWrapper) GetSimpleNoExplodeObject(ctx echo.Context) error

GetSimpleNoExplodeObject converts echo context to params.

func (*ServerInterfaceWrapper) GetSimplePrimitive 

func (w *ServerInterfaceWrapper) GetSimplePrimitive(ctx echo.Context) error

GetSimplePrimitive converts echo context to params.

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.