components

package
v1.3.5-0...-3665896 Latest Latest
Warning

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

 Go to latest Published: Jan 27, 2020 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

Package components 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 NewBodyWithAddPropsRequest 

func NewBodyWithAddPropsRequest(server string, body BodyWithAddPropsJSONRequestBody) (*http.Request, error)

NewBodyWithAddPropsRequest calls the generic BodyWithAddProps builder with application/json body

func NewBodyWithAddPropsRequestWithBody 

func NewBodyWithAddPropsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewBodyWithAddPropsRequestWithBody generates requests for BodyWithAddProps with any type of body

func NewParamsWithAddPropsRequest 

func NewParamsWithAddPropsRequest(server string, params *ParamsWithAddPropsParams) (*http.Request, error)

NewParamsWithAddPropsRequest generates requests for ParamsWithAddProps

func ParseBodyWithAddPropsResponse 

func ParseBodyWithAddPropsResponse(rsp *http.Response) (*bodyWithAddPropsResponse, error)

ParseBodyWithAddPropsResponse parses an HTTP response from a BodyWithAddPropsWithResponse call

func ParseParamsWithAddPropsResponse 

func ParseParamsWithAddPropsResponse(rsp *http.Response) (*paramsWithAddPropsResponse, error)

ParseParamsWithAddPropsResponse parses an HTTP response from a ParamsWithAddPropsWithResponse call

func RegisterHandlers 

func RegisterHandlers(router interface {
	CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
}, si ServerInterface, options ...HandlerOption)

RegisterHandlers adds each server route to the EchoRouter.

Types

type AdditionalPropertiesObject1 

type AdditionalPropertiesObject1 struct {
	Id                   int            `json:"id"`
	Name                 string         `json:"name"`
	Optional             *string        `json:"optional,omitempty"`
	AdditionalProperties map[string]int `json:"-"`
}

AdditionalPropertiesObject1 defines model for AdditionalPropertiesObject1.

func (AdditionalPropertiesObject1) Get 

func (a AdditionalPropertiesObject1) Get(fieldName string) (value int, found bool)

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

func (AdditionalPropertiesObject1) MarshalJSON 

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

Override default JSON handling for AdditionalPropertiesObject1 to handle AdditionalProperties

func (*AdditionalPropertiesObject1) Set 

func (a *AdditionalPropertiesObject1) Set(fieldName string, value int)

Setter for additional properties for AdditionalPropertiesObject1

func (*AdditionalPropertiesObject1) UnmarshalJSON 

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

Override default JSON handling for AdditionalPropertiesObject1 to handle AdditionalProperties

type AdditionalPropertiesObject2 

type AdditionalPropertiesObject2 struct {
	Id   int    `json:"id"`
	Name string `json:"name"`
}

AdditionalPropertiesObject2 defines model for AdditionalPropertiesObject2.

type AdditionalPropertiesObject3 

type AdditionalPropertiesObject3 struct {
	Name                 string                 `json:"name"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

AdditionalPropertiesObject3 defines model for AdditionalPropertiesObject3.

func (AdditionalPropertiesObject3) Get 

func (a AdditionalPropertiesObject3) Get(fieldName string) (value interface{}, found bool)

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

func (AdditionalPropertiesObject3) MarshalJSON 

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

Override default JSON handling for AdditionalPropertiesObject3 to handle AdditionalProperties

func (*AdditionalPropertiesObject3) Set 

func (a *AdditionalPropertiesObject3) Set(fieldName string, value interface{})

Setter for additional properties for AdditionalPropertiesObject3

func (*AdditionalPropertiesObject3) UnmarshalJSON 

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

Override default JSON handling for AdditionalPropertiesObject3 to handle AdditionalProperties

type AdditionalPropertiesObject4 

type AdditionalPropertiesObject4 struct {
	Inner                AdditionalPropertiesObject4_Inner `json:"inner"`
	Name                 string                            `json:"name"`
	AdditionalProperties map[string]interface{}            `json:"-"`
}

AdditionalPropertiesObject4 defines model for AdditionalPropertiesObject4.

func (AdditionalPropertiesObject4) Get 

func (a AdditionalPropertiesObject4) Get(fieldName string) (value interface{}, found bool)

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

func (AdditionalPropertiesObject4) MarshalJSON 

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

Override default JSON handling for AdditionalPropertiesObject4 to handle AdditionalProperties

func (*AdditionalPropertiesObject4) Set 

func (a *AdditionalPropertiesObject4) Set(fieldName string, value interface{})

Setter for additional properties for AdditionalPropertiesObject4

func (*AdditionalPropertiesObject4) UnmarshalJSON 

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

Override default JSON handling for AdditionalPropertiesObject4 to handle AdditionalProperties

type AdditionalPropertiesObject4_Inner 

type AdditionalPropertiesObject4_Inner struct {
	Name                 string                 `json:"name"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

AdditionalPropertiesObject4_Inner defines model for AdditionalPropertiesObject4.Inner.

func (AdditionalPropertiesObject4_Inner) Get 

func (a AdditionalPropertiesObject4_Inner) Get(fieldName string) (value interface{}, found bool)

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

func (AdditionalPropertiesObject4_Inner) MarshalJSON 

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

Override default JSON handling for AdditionalPropertiesObject4_Inner to handle AdditionalProperties

func (*AdditionalPropertiesObject4_Inner) Set 

func (a *AdditionalPropertiesObject4_Inner) Set(fieldName string, value interface{})

Setter for additional properties for AdditionalPropertiesObject4_Inner

func (*AdditionalPropertiesObject4_Inner) UnmarshalJSON 

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

Override default JSON handling for AdditionalPropertiesObject4_Inner to handle AdditionalProperties

type AdditionalPropertiesObject5 

type AdditionalPropertiesObject5 struct {
	AdditionalProperties map[string]SchemaObject `json:"-"`
}

AdditionalPropertiesObject5 defines model for AdditionalPropertiesObject5.

func (AdditionalPropertiesObject5) Get 

func (a AdditionalPropertiesObject5) Get(fieldName string) (value SchemaObject, found bool)

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

func (AdditionalPropertiesObject5) MarshalJSON 

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

Override default JSON handling for AdditionalPropertiesObject5 to handle AdditionalProperties

func (*AdditionalPropertiesObject5) Set 

func (a *AdditionalPropertiesObject5) Set(fieldName string, value SchemaObject)

Setter for additional properties for AdditionalPropertiesObject5

func (*AdditionalPropertiesObject5) UnmarshalJSON 

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

Override default JSON handling for AdditionalPropertiesObject5 to handle AdditionalProperties

type BodyWithAddPropsJSONBody 

type BodyWithAddPropsJSONBody struct {
	Inner                BodyWithAddPropsJSONBody_Inner `json:"inner"`
	Name                 string                         `json:"name"`
	AdditionalProperties map[string]interface{}         `json:"-"`
}

BodyWithAddPropsJSONBody defines parameters for BodyWithAddProps.

func (BodyWithAddPropsJSONBody) Get 

func (a BodyWithAddPropsJSONBody) Get(fieldName string) (value interface{}, found bool)

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

func (BodyWithAddPropsJSONBody) MarshalJSON 

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

Override default JSON handling for BodyWithAddPropsJSONBody to handle AdditionalProperties

func (*BodyWithAddPropsJSONBody) Set 

func (a *BodyWithAddPropsJSONBody) Set(fieldName string, value interface{})

Setter for additional properties for BodyWithAddPropsJSONBody

func (*BodyWithAddPropsJSONBody) UnmarshalJSON 

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

Override default JSON handling for BodyWithAddPropsJSONBody to handle AdditionalProperties

type BodyWithAddPropsJSONBody_Inner 

type BodyWithAddPropsJSONBody_Inner struct {
	AdditionalProperties map[string]int `json:"-"`
}

BodyWithAddPropsJSONBody_Inner defines parameters for BodyWithAddProps.

func (BodyWithAddPropsJSONBody_Inner) Get 

func (a BodyWithAddPropsJSONBody_Inner) Get(fieldName string) (value int, found bool)

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

func (BodyWithAddPropsJSONBody_Inner) MarshalJSON 

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

Override default JSON handling for BodyWithAddPropsJSONBody_Inner to handle AdditionalProperties

func (*BodyWithAddPropsJSONBody_Inner) Set 

func (a *BodyWithAddPropsJSONBody_Inner) Set(fieldName string, value int)

Setter for additional properties for BodyWithAddPropsJSONBody_Inner

func (*BodyWithAddPropsJSONBody_Inner) UnmarshalJSON 

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

Override default JSON handling for BodyWithAddPropsJSONBody_Inner to handle AdditionalProperties

type BodyWithAddPropsJSONRequestBody 

type BodyWithAddPropsJSONRequestBody BodyWithAddPropsJSONBody

BodyWithAddPropsRequestBody defines body for BodyWithAddProps for application/json ContentType.

type Client 

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

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

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

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) BodyWithAddProps 

func (c *Client) BodyWithAddProps(ctx context.Context, body BodyWithAddPropsJSONRequestBody) (*http.Response, error)

func (*Client) BodyWithAddPropsWithBody 

func (c *Client) BodyWithAddPropsWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

func (*Client) ParamsWithAddProps 

func (c *Client) ParamsWithAddProps(ctx context.Context, params *ParamsWithAddPropsParams) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// ParamsWithAddProps request
	ParamsWithAddProps(ctx context.Context, params *ParamsWithAddPropsParams) (*http.Response, error)

	// BodyWithAddProps request  with any body
	BodyWithAddPropsWithBody(ctx context.Context, contentType string, body io.Reader) (*http.Response, error)

	BodyWithAddProps(ctx context.Context, body BodyWithAddPropsJSONRequestBody) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn 

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

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

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses 

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

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

func (*ClientWithResponses) BodyWithAddPropsWithBodyWithResponse 

func (c *ClientWithResponses) BodyWithAddPropsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*bodyWithAddPropsResponse, error)

BodyWithAddPropsWithBodyWithResponse request with arbitrary body returning *BodyWithAddPropsResponse

func (*ClientWithResponses) BodyWithAddPropsWithResponse 

func (c *ClientWithResponses) BodyWithAddPropsWithResponse(ctx context.Context, body BodyWithAddPropsJSONRequestBody) (*bodyWithAddPropsResponse, error)

func (*ClientWithResponses) ParamsWithAddPropsWithResponse 

func (c *ClientWithResponses) ParamsWithAddPropsWithResponse(ctx context.Context, params *ParamsWithAddPropsParams) (*paramsWithAddPropsResponse, error)

ParamsWithAddPropsWithResponse request returning *ParamsWithAddPropsResponse

type HandlerOption 

type HandlerOption func(wrapper *ServerInterfaceWrapper)

func WithSecurity 

func WithSecurity(guard func(ctx echo.Context, provider string, _ []string) error) HandlerOption

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type ObjectWithJsonField 

type ObjectWithJsonField struct {
	Name   string          `json:"name"`
	Value1 json.RawMessage `json:"value1"`
	Value2 json.RawMessage `json:"value2,omitempty"`
}

ObjectWithJsonField defines model for ObjectWithJsonField.

type ParameterObject 

type ParameterObject string

ParameterObject defines model for ParameterObject.

type ParamsWithAddPropsParams 

type ParamsWithAddPropsParams struct {

	// This parameter has additional properties
	P1 ParamsWithAddPropsParams_P1 `json:"p1"`

	// This parameter has an anonymous inner property which needs to be
	// turned into a proper type for additionalProperties to work
	P2 struct {
		Inner ParamsWithAddPropsParams_P2_Inner `json:"inner"`
	} `json:"p2"`
}

ParamsWithAddPropsParams defines parameters for ParamsWithAddProps.

type ParamsWithAddPropsParams_P1 

type ParamsWithAddPropsParams_P1 struct {
	AdditionalProperties map[string]interface{} `json:"-"`
}

ParamsWithAddPropsParams_P1 defines parameters for ParamsWithAddProps.

func (ParamsWithAddPropsParams_P1) Get 

func (a ParamsWithAddPropsParams_P1) Get(fieldName string) (value interface{}, found bool)

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

func (ParamsWithAddPropsParams_P1) MarshalJSON 

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

Override default JSON handling for ParamsWithAddPropsParams_P1 to handle AdditionalProperties

func (*ParamsWithAddPropsParams_P1) Set 

func (a *ParamsWithAddPropsParams_P1) Set(fieldName string, value interface{})

Setter for additional properties for ParamsWithAddPropsParams_P1

func (*ParamsWithAddPropsParams_P1) UnmarshalJSON 

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

Override default JSON handling for ParamsWithAddPropsParams_P1 to handle AdditionalProperties

type ParamsWithAddPropsParams_P2_Inner 

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

ParamsWithAddPropsParams_P2_Inner defines parameters for ParamsWithAddProps.

func (ParamsWithAddPropsParams_P2_Inner) Get 

func (a ParamsWithAddPropsParams_P2_Inner) Get(fieldName string) (value string, found bool)

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

func (ParamsWithAddPropsParams_P2_Inner) MarshalJSON 

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

Override default JSON handling for ParamsWithAddPropsParams_P2_Inner to handle AdditionalProperties

func (*ParamsWithAddPropsParams_P2_Inner) Set 

func (a *ParamsWithAddPropsParams_P2_Inner) Set(fieldName string, value string)

Setter for additional properties for ParamsWithAddPropsParams_P2_Inner

func (*ParamsWithAddPropsParams_P2_Inner) UnmarshalJSON 

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

Override default JSON handling for ParamsWithAddPropsParams_P2_Inner to handle AdditionalProperties

type RequestBody 

type RequestBody struct {
	Field SchemaObject `json:"Field"`
}

RequestBody defines model for RequestBody.

type RequestEditorFn 

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

RequestEditorFn is the function signature for the RequestEditor callback function

type ResponseObject 

type ResponseObject struct {
	Field SchemaObject `json:"Field"`
}

ResponseObject defines model for ResponseObject.

type SchemaObject 

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

SchemaObject defines model for SchemaObject.

type ServerInterface 

type ServerInterface interface {

	// (GET /params_with_add_props)
	ParamsWithAddProps(ctx echo.Context, params ParamsWithAddPropsParams) error

	// (POST /params_with_add_props)
	BodyWithAddProps(ctx echo.Context) error
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper 

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) BodyWithAddProps 

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

BodyWithAddProps converts echo context to params.

func (*ServerInterfaceWrapper) ParamsWithAddProps 

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

ParamsWithAddProps 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.