issue_52

Documentation

Overview

Package issue_52 provides primitives to interact the openapi HTTP API.

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

Index

• func GetSwagger() (*openapi3.Swagger, error)
• func NewExampleGetRequest(server string) (*http.Request, error)
• func ParseexampleGetResponse(rsp *http.Response) (*exampleGetResponse, error)
• func RegisterHandlers(router runtime.EchoRouter, si ServerInterface)
• type ArrayValue
• type Client
  • func NewClient(ctx context.Context, opts ...Option) (*Client, error)
  • func (c *Client) ExampleGet(ctx context.Context) (*http.Response, error)
  • func (c *Client) Intercept(req *http.Request, ctx context.Context) error
• type ClientInterface
• type ClientWithResponses
  • func NewClientWithResponses(server string) *ClientWithResponses
  • func NewClientWithResponsesAndRequestEditorFunc(server string, reqEditorFn RequestEditorFn) *ClientWithResponses
  • func (c *ClientWithResponses) ExampleGetWithResponse(ctx context.Context) (*exampleGetResponse, error)
• type Document
• type Document_Fields
  • func (a Document_Fields) Get(fieldName string) (value Value, found bool)
  • func (a Document_Fields) MarshalJSON() ([]byte, error)
  • func (a *Document_Fields) Set(fieldName string, value Value)
  • func (a *Document_Fields) UnmarshalJSON(b []byte) error
• type Interceptor
• type InterceptorFn
  • func (f InterceptorFn) Intercept(req *http.Request, ctx context.Context) error
• type Option
  • func WithBaseURL(baseURL string) Option
  • func WithHTTPClient(httpClient *http.Client) Option
  • func WithIdleTimeout(timeout time.Duration) Option
  • func WithInterceptors(interceptors ...Interceptor) Option
  • func WithMaxIdleConnections(maxIdleConns uint) Option
  • func WithRequestCompletionFn(fn RequestCompletionFn) Option
  • func WithRequestEditorFn(fn RequestEditorFn) Option
  • func WithRequestTimeout(timeout time.Duration) Option
  • func WithUserAgent(userAgent string) Option
• type RequestCompletionFn
• type RequestEditorFn
• type ServerInterface
• type ServerInterfaceWrapper
  • func (w *ServerInterfaceWrapper) ExampleGet(ctx echo.Context) error
• type Value

Functions

func GetSwagger

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

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

func NewExampleGetRequest

func NewExampleGetRequest(server string) (*http.Request, error)

NewExampleGetRequest generates requests for ExampleGet

func ParseexampleGetResponse

func ParseexampleGetResponse(rsp *http.Response) (*exampleGetResponse, error)

ParseexampleGetResponse parses an HTTP response from a ExampleGetWithResponse call

func RegisterHandlers

func RegisterHandlers(router runtime.EchoRouter, si ServerInterface)

RegisterHandlers adds each server route to the EchoRouter.

Types

type ArrayValue

type ArrayValue []Value

ArrayValue defines model for ArrayValue.

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) ExampleGet

func (c *Client) ExampleGet(ctx context.Context) (*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

	// ExampleGet request
	ExampleGet(ctx context.Context) (*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) ExampleGetWithResponse

func (c *ClientWithResponses) ExampleGetWithResponse(ctx context.Context) (*exampleGetResponse, error)

ExampleGetWithResponse request returning *ExampleGetResponse

type Document

type Document struct {
	Fields *Document_Fields `json:"fields,omitempty"`
}

Document defines model for Document.

type Document_Fields

type Document_Fields struct {
	AdditionalProperties map[string]Value `json:"-"`
}

Document_Fields defines model for Document.Fields.

func (Document_Fields) Get

func (a Document_Fields) Get(fieldName string) (value Value, found bool)

Getter for additional properties for Document_Fields. Returns the specified element and whether it was found

func (Document_Fields) MarshalJSON

func (a Document_Fields) MarshalJSON() ([]byte, error)

Override default JSON handling for Document_Fields to handle AdditionalProperties

func (*Document_Fields) Set

func (a *Document_Fields) Set(fieldName string, value Value)

Setter for additional properties for Document_Fields

func (*Document_Fields) UnmarshalJSON

func (a *Document_Fields) UnmarshalJSON(b []byte) error

Override default JSON handling for Document_Fields to handle AdditionalProperties

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 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 /example)
	ExampleGet(ctx echo.Context) error
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) ExampleGet

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

ExampleGet converts echo context to params.

type Value

type Value struct {
	ArrayValue  *ArrayValue `json:"arrayValue,omitempty"`
	StringValue *string     `json:"stringValue,omitempty"`
}

Value defines model for Value.