components

package
v1.2.0 Latest Latest
Warning

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

Go to latest
Published: Jul 5, 2019 License: Apache-2.0 Imports: 14 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 added in v1.2.0

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

NewBodyWithAddPropsRequest generates requests for BodyWithAddProps with JSON body

func NewBodyWithAddPropsRequestWithBody added in v1.2.0

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

NewBodyWithAddPropsRequestWithBody generates requests for BodyWithAddProps with non-JSON body

func NewParamsWithAddPropsRequest added in v1.2.0

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

NewParamsWithAddPropsRequest generates requests for ParamsWithAddProps

func ParsebodyWithAddPropsResponse added in v1.2.0

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

ParsebodyWithAddPropsResponse parses an HTTP response from a BodyWithAddPropsWithResponse call

func ParseparamsWithAddPropsResponse added in v1.2.0

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

ParseparamsWithAddPropsResponse parses an HTTP response from a ParamsWithAddPropsWithResponse call

func RegisterHandlers

func RegisterHandlers(router runtime.EchoRouter, si ServerInterface)

RegisterHandlers adds each server route to the EchoRouter.

Types

type AdditionalPropertiesObject1 added in v1.2.0

type AdditionalPropertiesObject1 struct {
	Id       int     `json:"id"`
	Name     string  `json:"name"`
	Optional *string `json:"optional,omitempty"`
	// contains filtered or unexported fields
}

AdditionalPropertiesObject1 defines model for AdditionalPropertiesObject1.

func (AdditionalPropertiesObject1) AdditionalProperties added in v1.2.0

func (a AdditionalPropertiesObject1) AdditionalProperties() map[string]int

Returns the additional properties dict

func (AdditionalPropertiesObject1) Get added in v1.2.0

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 added in v1.2.0

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

Override default JSON handling for AdditionalPropertiesObject1 to handle additionalProperties

func (*AdditionalPropertiesObject1) Set added in v1.2.0

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

Setter for additional properties for AdditionalPropertiesObject1

func (*AdditionalPropertiesObject1) UnmarshalJSON added in v1.2.0

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

Override default JSON handling for AdditionalPropertiesObject1 to handle additionalProperties

type AdditionalPropertiesObject2 added in v1.2.0

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

AdditionalPropertiesObject2 defines model for AdditionalPropertiesObject2.

type AdditionalPropertiesObject3 added in v1.2.0

type AdditionalPropertiesObject3 struct {
	Name string `json:"name"`
	// contains filtered or unexported fields
}

AdditionalPropertiesObject3 defines model for AdditionalPropertiesObject3.

func (AdditionalPropertiesObject3) AdditionalProperties added in v1.2.0

func (a AdditionalPropertiesObject3) AdditionalProperties() map[string]interface{}

Returns the additional properties dict

func (AdditionalPropertiesObject3) Get added in v1.2.0

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 added in v1.2.0

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

Override default JSON handling for AdditionalPropertiesObject3 to handle additionalProperties

func (*AdditionalPropertiesObject3) Set added in v1.2.0

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

Setter for additional properties for AdditionalPropertiesObject3

func (*AdditionalPropertiesObject3) UnmarshalJSON added in v1.2.0

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

Override default JSON handling for AdditionalPropertiesObject3 to handle additionalProperties

type AdditionalPropertiesObject4 added in v1.2.0

type AdditionalPropertiesObject4 struct {
	Inner AdditionalPropertiesObject4_Inner `json:"inner"`
	Name  string                            `json:"name"`
	// contains filtered or unexported fields
}

AdditionalPropertiesObject4 defines model for AdditionalPropertiesObject4.

func (AdditionalPropertiesObject4) AdditionalProperties added in v1.2.0

func (a AdditionalPropertiesObject4) AdditionalProperties() map[string]interface{}

Returns the additional properties dict

func (AdditionalPropertiesObject4) Get added in v1.2.0

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 added in v1.2.0

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

Override default JSON handling for AdditionalPropertiesObject4 to handle additionalProperties

func (*AdditionalPropertiesObject4) Set added in v1.2.0

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

Setter for additional properties for AdditionalPropertiesObject4

func (*AdditionalPropertiesObject4) UnmarshalJSON added in v1.2.0

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

Override default JSON handling for AdditionalPropertiesObject4 to handle additionalProperties

type AdditionalPropertiesObject4_Inner added in v1.2.0

type AdditionalPropertiesObject4_Inner struct {
	Name string `json:"name"`
	// contains filtered or unexported fields
}

AdditionalPropertiesObject4_Inner defines model for AdditionalPropertiesObject4.Inner.

func (AdditionalPropertiesObject4_Inner) AdditionalProperties added in v1.2.0

func (a AdditionalPropertiesObject4_Inner) AdditionalProperties() map[string]interface{}

Returns the additional properties dict

func (AdditionalPropertiesObject4_Inner) Get added in v1.2.0

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 added in v1.2.0

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

Override default JSON handling for AdditionalPropertiesObject4_Inner to handle additionalProperties

func (*AdditionalPropertiesObject4_Inner) Set added in v1.2.0

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

Setter for additional properties for AdditionalPropertiesObject4_Inner

func (*AdditionalPropertiesObject4_Inner) UnmarshalJSON added in v1.2.0

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

Override default JSON handling for AdditionalPropertiesObject4_Inner to handle additionalProperties

type BodyWithAddPropsJSONBody added in v1.2.0

type BodyWithAddPropsJSONBody struct {
	Inner BodyWithAddPropsJSONBody_Inner `json:"inner"`
	Name  string                         `json:"name"`
	// contains filtered or unexported fields
}

BodyWithAddPropsJSONBody defines parameters for BodyWithAddProps.

func (BodyWithAddPropsJSONBody) AdditionalProperties added in v1.2.0

func (a BodyWithAddPropsJSONBody) AdditionalProperties() map[string]interface{}

Returns the additional properties dict

func (BodyWithAddPropsJSONBody) Get added in v1.2.0

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 added in v1.2.0

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

Override default JSON handling for BodyWithAddPropsJSONBody to handle additionalProperties

func (*BodyWithAddPropsJSONBody) Set added in v1.2.0

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

Setter for additional properties for BodyWithAddPropsJSONBody

func (*BodyWithAddPropsJSONBody) UnmarshalJSON added in v1.2.0

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

Override default JSON handling for BodyWithAddPropsJSONBody to handle additionalProperties

type BodyWithAddPropsJSONBody_Inner added in v1.2.0

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

BodyWithAddPropsJSONBody_Inner defines parameters for BodyWithAddProps.

func (BodyWithAddPropsJSONBody_Inner) AdditionalProperties added in v1.2.0

func (a BodyWithAddPropsJSONBody_Inner) AdditionalProperties() map[string]int

Returns the additional properties dict

func (BodyWithAddPropsJSONBody_Inner) Get added in v1.2.0

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 added in v1.2.0

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

Override default JSON handling for BodyWithAddPropsJSONBody_Inner to handle additionalProperties

func (*BodyWithAddPropsJSONBody_Inner) Set added in v1.2.0

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

Setter for additional properties for BodyWithAddPropsJSONBody_Inner

func (*BodyWithAddPropsJSONBody_Inner) UnmarshalJSON added in v1.2.0

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

Override default JSON handling for BodyWithAddPropsJSONBody_Inner to handle additionalProperties

type Client added in v1.1.0

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 func(req *http.Request, ctx context.Context) error
}

Client which conforms to the OpenAPI3 specification for this service.

func (*Client) BodyWithAddProps added in v1.2.0

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

BodyWithAddProps request with JSON body

func (*Client) ParamsWithAddProps added in v1.2.0

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

ParamsWithAddProps request

type ClientInterface added in v1.1.5

type ClientInterface interface {

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

	// BodyWithAddProps request with JSON body
	BodyWithAddProps(ctx context.Context, body BodyWithAddPropsJSONBody) (*http.Response, error)
}

The interface specification for the client above.

type ClientWithResponses added in v1.1.6

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses added in v1.1.6

func NewClientWithResponses(server string) *ClientWithResponses

NewClientWithResponses returns a ClientWithResponses with a default Client:

func (*ClientWithResponses) BodyWithAddPropsWithResponse added in v1.2.0

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

BodyWithAddProps request with JSON body returning *BodyWithAddPropsResponse

func (*ClientWithResponses) ParamsWithAddPropsWithResponse added in v1.2.0

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

ParamsWithAddProps request returning *ParamsWithAddPropsResponse

type ObjectWithJsonField added in v1.1.7

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 added in v1.2.0

type ParamsWithAddPropsParams struct {
	P1 ParamsWithAddPropsParams_P1 `json:"p1"`
	P2 struct {
		Inner ParamsWithAddPropsParams_P2_Inner `json:"inner"`
	} `json:"p2"`
}

ParamsWithAddPropsParams defines parameters for ParamsWithAddProps.

type ParamsWithAddPropsParams_P1 added in v1.2.0

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

ParamsWithAddPropsParams_P1 defines parameters for ParamsWithAddProps.

func (ParamsWithAddPropsParams_P1) AdditionalProperties added in v1.2.0

func (a ParamsWithAddPropsParams_P1) AdditionalProperties() map[string]interface{}

Returns the additional properties dict

func (ParamsWithAddPropsParams_P1) Get added in v1.2.0

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 added in v1.2.0

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

Override default JSON handling for ParamsWithAddPropsParams_P1 to handle additionalProperties

func (*ParamsWithAddPropsParams_P1) Set added in v1.2.0

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

Setter for additional properties for ParamsWithAddPropsParams_P1

func (*ParamsWithAddPropsParams_P1) UnmarshalJSON added in v1.2.0

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

Override default JSON handling for ParamsWithAddPropsParams_P1 to handle additionalProperties

type ParamsWithAddPropsParams_P2_Inner added in v1.2.0

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

ParamsWithAddPropsParams_P2_Inner defines parameters for ParamsWithAddProps.

func (ParamsWithAddPropsParams_P2_Inner) AdditionalProperties added in v1.2.0

func (a ParamsWithAddPropsParams_P2_Inner) AdditionalProperties() map[string]string

Returns the additional properties dict

func (ParamsWithAddPropsParams_P2_Inner) Get added in v1.2.0

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 added in v1.2.0

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

Override default JSON handling for ParamsWithAddPropsParams_P2_Inner to handle additionalProperties

func (*ParamsWithAddPropsParams_P2_Inner) Set added in v1.2.0

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

Setter for additional properties for ParamsWithAddPropsParams_P2_Inner

func (*ParamsWithAddPropsParams_P2_Inner) UnmarshalJSON added in v1.2.0

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 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 added in v1.2.0

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

BodyWithAddProps converts echo context to params.

func (*ServerInterfaceWrapper) ParamsWithAddProps added in v1.2.0

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

ParamsWithAddProps converts echo context to params.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL