Documentation ¶
Overview ¶
Package components provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen version (devel) DO NOT EDIT.
Index ¶
- func GetSwagger() (swagger *openapi3.T, err error)
- func NewBodyWithAddPropsRequest(server string, body BodyWithAddPropsJSONRequestBody) (*http.Request, error)
- func NewBodyWithAddPropsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewEnsureEverythingIsReferencedRequest(server string, body EnsureEverythingIsReferencedJSONRequestBody) (*http.Request, error)
- func NewEnsureEverythingIsReferencedRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewParamsWithAddPropsRequest(server string, params *ParamsWithAddPropsParams) (*http.Request, error)
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- func RegisterHandlers(router EchoRouter, si ServerInterface)
- func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)
- type AdditionalPropertiesObject1
- type AdditionalPropertiesObject2
- type AdditionalPropertiesObject3
- func (a AdditionalPropertiesObject3) Get(fieldName string) (value interface{}, found bool)
- func (a AdditionalPropertiesObject3) MarshalJSON() ([]byte, error)
- func (a *AdditionalPropertiesObject3) Set(fieldName string, value interface{})
- func (a *AdditionalPropertiesObject3) UnmarshalJSON(b []byte) error
- type AdditionalPropertiesObject4
- func (a AdditionalPropertiesObject4) Get(fieldName string) (value interface{}, found bool)
- func (a AdditionalPropertiesObject4) MarshalJSON() ([]byte, error)
- func (a *AdditionalPropertiesObject4) Set(fieldName string, value interface{})
- func (a *AdditionalPropertiesObject4) UnmarshalJSON(b []byte) error
- type AdditionalPropertiesObject4_Inner
- func (a AdditionalPropertiesObject4_Inner) Get(fieldName string) (value interface{}, found bool)
- func (a AdditionalPropertiesObject4_Inner) MarshalJSON() ([]byte, error)
- func (a *AdditionalPropertiesObject4_Inner) Set(fieldName string, value interface{})
- func (a *AdditionalPropertiesObject4_Inner) UnmarshalJSON(b []byte) error
- type AdditionalPropertiesObject5
- func (a AdditionalPropertiesObject5) Get(fieldName string) (value SchemaObject, found bool)
- func (a AdditionalPropertiesObject5) MarshalJSON() ([]byte, error)
- func (a *AdditionalPropertiesObject5) Set(fieldName string, value SchemaObject)
- func (a *AdditionalPropertiesObject5) UnmarshalJSON(b []byte) error
- type BodyWithAddPropsJSONBody
- type BodyWithAddPropsJSONBody_Inner
- func (a BodyWithAddPropsJSONBody_Inner) Get(fieldName string) (value int, found bool)
- func (a BodyWithAddPropsJSONBody_Inner) MarshalJSON() ([]byte, error)
- func (a *BodyWithAddPropsJSONBody_Inner) Set(fieldName string, value int)
- func (a *BodyWithAddPropsJSONBody_Inner) UnmarshalJSON(b []byte) error
- type BodyWithAddPropsJSONRequestBody
- type BodyWithAddPropsResponse
- type Client
- func (c *Client) BodyWithAddProps(ctx context.Context, body BodyWithAddPropsJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) BodyWithAddPropsWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) EnsureEverythingIsReferenced(ctx context.Context, body EnsureEverythingIsReferencedJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) EnsureEverythingIsReferencedWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) ParamsWithAddProps(ctx context.Context, params *ParamsWithAddPropsParams, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) BodyWithAddPropsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*BodyWithAddPropsResponse, error)
- func (c *ClientWithResponses) BodyWithAddPropsWithResponse(ctx context.Context, body BodyWithAddPropsJSONRequestBody, ...) (*BodyWithAddPropsResponse, error)
- func (c *ClientWithResponses) EnsureEverythingIsReferencedWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, ...) (*EnsureEverythingIsReferencedResponse, error)
- func (c *ClientWithResponses) EnsureEverythingIsReferencedWithResponse(ctx context.Context, body EnsureEverythingIsReferencedJSONRequestBody, ...) (*EnsureEverythingIsReferencedResponse, error)
- func (c *ClientWithResponses) ParamsWithAddPropsWithResponse(ctx context.Context, params *ParamsWithAddPropsParams, ...) (*ParamsWithAddPropsResponse, error)
- type ClientWithResponsesInterface
- type EchoRouter
- type EnsureEverythingIsReferencedJSONRequestBody
- type EnsureEverythingIsReferencedResponse
- type HttpRequestDoer
- type ObjectWithJsonField
- type ParamsWithAddPropsParams
- type ParamsWithAddPropsParams_P1
- func (a ParamsWithAddPropsParams_P1) Get(fieldName string) (value interface{}, found bool)
- func (a ParamsWithAddPropsParams_P1) MarshalJSON() ([]byte, error)
- func (a *ParamsWithAddPropsParams_P1) Set(fieldName string, value interface{})
- func (a *ParamsWithAddPropsParams_P1) UnmarshalJSON(b []byte) error
- type ParamsWithAddPropsParams_P2_Inner
- func (a ParamsWithAddPropsParams_P2_Inner) Get(fieldName string) (value string, found bool)
- func (a ParamsWithAddPropsParams_P2_Inner) MarshalJSON() ([]byte, error)
- func (a *ParamsWithAddPropsParams_P2_Inner) Set(fieldName string, value string)
- func (a *ParamsWithAddPropsParams_P2_Inner) UnmarshalJSON(b []byte) error
- type ParamsWithAddPropsResponse
- type RequestBody
- type RequestEditorFn
- type ResponseObject
- type SchemaObject
- type ServerInterface
- type ServerInterfaceWrapper
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetSwagger ¶
GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.
func NewBodyWithAddPropsRequest ¶ added in v1.2.0
func NewBodyWithAddPropsRequest(server string, body BodyWithAddPropsJSONRequestBody) (*http.Request, error)
NewBodyWithAddPropsRequest calls the generic BodyWithAddProps builder with application/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 any type of body
func NewEnsureEverythingIsReferencedRequest ¶ added in v1.3.7
func NewEnsureEverythingIsReferencedRequest(server string, body EnsureEverythingIsReferencedJSONRequestBody) (*http.Request, error)
NewEnsureEverythingIsReferencedRequest calls the generic EnsureEverythingIsReferenced builder with application/json body
func NewEnsureEverythingIsReferencedRequestWithBody ¶ added in v1.3.7
func NewEnsureEverythingIsReferencedRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewEnsureEverythingIsReferencedRequestWithBody generates requests for EnsureEverythingIsReferenced with any type of body
func NewParamsWithAddPropsRequest ¶ added in v1.2.0
func NewParamsWithAddPropsRequest(server string, params *ParamsWithAddPropsParams) (*http.Request, error)
NewParamsWithAddPropsRequest generates requests for ParamsWithAddProps
func PathToRawSpec ¶ added in v1.6.1
Constructs a synthetic filesystem for resolving external references when loading openapi specifications.
func RegisterHandlers ¶
func RegisterHandlers(router EchoRouter, si ServerInterface)
RegisterHandlers adds each server route to the EchoRouter.
func RegisterHandlersWithBaseURL ¶ added in v1.4.0
func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)
Registers handlers, and prepends BaseURL to the paths, so that the paths can be served under a prefix.
Types ¶
type AdditionalPropertiesObject1 ¶ added in v1.2.0
type AdditionalPropertiesObject1 struct { Id int `json:"id"` Name string `json:"name"` Optional *string `json:"optional,omitempty"` AdditionalProperties map[string]int `json:"-"` }
Has additional properties of type int
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
Does not allow additional properties
type AdditionalPropertiesObject3 ¶ added in v1.2.0
type AdditionalPropertiesObject3 struct { Name string `json:"name"` AdditionalProperties map[string]interface{} `json:"-"` }
Allows any additional property
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"` AdditionalProperties map[string]interface{} `json:"-"` }
Has anonymous field which has additional properties
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"` AdditionalProperties map[string]interface{} `json:"-"` }
AdditionalPropertiesObject4_Inner defines model for AdditionalPropertiesObject4.Inner.
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 AdditionalPropertiesObject5 ¶ added in v1.2.3
type AdditionalPropertiesObject5 struct {
AdditionalProperties map[string]SchemaObject `json:"-"`
}
Has additional properties with schema for dictionaries
func (AdditionalPropertiesObject5) Get ¶ added in v1.2.3
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 ¶ added in v1.2.3
func (a AdditionalPropertiesObject5) MarshalJSON() ([]byte, error)
Override default JSON handling for AdditionalPropertiesObject5 to handle AdditionalProperties
func (*AdditionalPropertiesObject5) Set ¶ added in v1.2.3
func (a *AdditionalPropertiesObject5) Set(fieldName string, value SchemaObject)
Setter for additional properties for AdditionalPropertiesObject5
func (*AdditionalPropertiesObject5) UnmarshalJSON ¶ added in v1.2.3
func (a *AdditionalPropertiesObject5) UnmarshalJSON(b []byte) error
Override default JSON handling for AdditionalPropertiesObject5 to handle AdditionalProperties
type BodyWithAddPropsJSONBody ¶ added in v1.2.0
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 ¶ 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
BodyWithAddPropsJSONBody_Inner defines parameters for BodyWithAddProps.
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 BodyWithAddPropsJSONRequestBody ¶ added in v1.2.3
type BodyWithAddPropsJSONRequestBody BodyWithAddPropsJSONBody
BodyWithAddPropsJSONRequestBody defines body for BodyWithAddProps for application/json ContentType.
type BodyWithAddPropsResponse ¶ added in v1.3.8
func ParseBodyWithAddPropsResponse ¶ added in v1.3.4
func ParseBodyWithAddPropsResponse(rsp *http.Response) (*BodyWithAddPropsResponse, error)
ParseBodyWithAddPropsResponse parses an HTTP response from a BodyWithAddPropsWithResponse call
func (BodyWithAddPropsResponse) Status ¶ added in v1.3.8
func (r BodyWithAddPropsResponse) Status() string
Status returns HTTPResponse.Status
func (BodyWithAddPropsResponse) StatusCode ¶ added in v1.3.8
func (r BodyWithAddPropsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
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. 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 HttpRequestDoer // A list of callbacks for modifying requests which are generated before sending over // the network. RequestEditors []RequestEditorFn }
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶ added in v1.3.1
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) BodyWithAddProps ¶ added in v1.2.0
func (c *Client) BodyWithAddProps(ctx context.Context, body BodyWithAddPropsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) BodyWithAddPropsWithBody ¶ added in v1.2.3
func (*Client) EnsureEverythingIsReferenced ¶ added in v1.3.7
func (c *Client) EnsureEverythingIsReferenced(ctx context.Context, body EnsureEverythingIsReferencedJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) EnsureEverythingIsReferencedWithBody ¶ added in v1.3.7
func (*Client) ParamsWithAddProps ¶ added in v1.2.0
func (c *Client) ParamsWithAddProps(ctx context.Context, params *ParamsWithAddPropsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
type ClientInterface ¶ added in v1.1.5
type ClientInterface interface { // EnsureEverythingIsReferenced request with any body EnsureEverythingIsReferencedWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) EnsureEverythingIsReferenced(ctx context.Context, body EnsureEverythingIsReferencedJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) // ParamsWithAddProps request ParamsWithAddProps(ctx context.Context, params *ParamsWithAddPropsParams, reqEditors ...RequestEditorFn) (*http.Response, error) // BodyWithAddProps request with any body BodyWithAddPropsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) BodyWithAddProps(ctx context.Context, body BodyWithAddPropsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) }
The interface specification for the client above.
type ClientOption ¶ added in v1.3.1
ClientOption allows setting custom parameters during construction
func WithBaseURL ¶ added in v1.3.1
func WithBaseURL(baseURL string) ClientOption
WithBaseURL overrides the baseURL.
func WithHTTPClient ¶ added in v1.3.1
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 ¶ added in v1.3.1
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 ¶ 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, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) BodyWithAddPropsWithBodyWithResponse ¶ added in v1.2.3
func (c *ClientWithResponses) BodyWithAddPropsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BodyWithAddPropsResponse, error)
BodyWithAddPropsWithBodyWithResponse request with arbitrary body returning *BodyWithAddPropsResponse
func (*ClientWithResponses) BodyWithAddPropsWithResponse ¶ added in v1.2.0
func (c *ClientWithResponses) BodyWithAddPropsWithResponse(ctx context.Context, body BodyWithAddPropsJSONRequestBody, reqEditors ...RequestEditorFn) (*BodyWithAddPropsResponse, error)
func (*ClientWithResponses) EnsureEverythingIsReferencedWithBodyWithResponse ¶ added in v1.3.7
func (c *ClientWithResponses) EnsureEverythingIsReferencedWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EnsureEverythingIsReferencedResponse, error)
EnsureEverythingIsReferencedWithBodyWithResponse request with arbitrary body returning *EnsureEverythingIsReferencedResponse
func (*ClientWithResponses) EnsureEverythingIsReferencedWithResponse ¶ added in v1.3.7
func (c *ClientWithResponses) EnsureEverythingIsReferencedWithResponse(ctx context.Context, body EnsureEverythingIsReferencedJSONRequestBody, reqEditors ...RequestEditorFn) (*EnsureEverythingIsReferencedResponse, error)
func (*ClientWithResponses) ParamsWithAddPropsWithResponse ¶ added in v1.2.0
func (c *ClientWithResponses) ParamsWithAddPropsWithResponse(ctx context.Context, params *ParamsWithAddPropsParams, reqEditors ...RequestEditorFn) (*ParamsWithAddPropsResponse, error)
ParamsWithAddPropsWithResponse request returning *ParamsWithAddPropsResponse
type ClientWithResponsesInterface ¶ added in v1.3.8
type ClientWithResponsesInterface interface { // EnsureEverythingIsReferenced request with any body EnsureEverythingIsReferencedWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*EnsureEverythingIsReferencedResponse, error) EnsureEverythingIsReferencedWithResponse(ctx context.Context, body EnsureEverythingIsReferencedJSONRequestBody, reqEditors ...RequestEditorFn) (*EnsureEverythingIsReferencedResponse, error) // ParamsWithAddProps request ParamsWithAddPropsWithResponse(ctx context.Context, params *ParamsWithAddPropsParams, reqEditors ...RequestEditorFn) (*ParamsWithAddPropsResponse, error) // BodyWithAddProps request with any body BodyWithAddPropsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BodyWithAddPropsResponse, error) BodyWithAddPropsWithResponse(ctx context.Context, body BodyWithAddPropsJSONRequestBody, reqEditors ...RequestEditorFn) (*BodyWithAddPropsResponse, error) }
ClientWithResponsesInterface is the interface specification for the client with responses above.
type EchoRouter ¶ added in v1.3.7
type EchoRouter 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 }
This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration
type EnsureEverythingIsReferencedJSONRequestBody ¶ added in v1.3.7
type EnsureEverythingIsReferencedJSONRequestBody RequestBody
EnsureEverythingIsReferencedJSONRequestBody defines body for EnsureEverythingIsReferenced for application/json ContentType.
type EnsureEverythingIsReferencedResponse ¶ added in v1.3.8
type EnsureEverythingIsReferencedResponse struct { Body []byte HTTPResponse *http.Response JSON200 *struct { // Has additional properties with schema for dictionaries Five *AdditionalPropertiesObject5 `json:"five,omitempty"` // Has anonymous field which has additional properties Four *AdditionalPropertiesObject4 `json:"four,omitempty"` JsonField *ObjectWithJsonField `json:"jsonField,omitempty"` // Has additional properties of type int One *AdditionalPropertiesObject1 `json:"one,omitempty"` // Allows any additional property Three *AdditionalPropertiesObject3 `json:"three,omitempty"` // Does not allow additional properties Two *AdditionalPropertiesObject2 `json:"two,omitempty"` } JSONDefault *struct { Field SchemaObject `json:"Field"` } }
func ParseEnsureEverythingIsReferencedResponse ¶ added in v1.3.7
func ParseEnsureEverythingIsReferencedResponse(rsp *http.Response) (*EnsureEverythingIsReferencedResponse, error)
ParseEnsureEverythingIsReferencedResponse parses an HTTP response from a EnsureEverythingIsReferencedWithResponse call
func (EnsureEverythingIsReferencedResponse) Status ¶ added in v1.3.8
func (r EnsureEverythingIsReferencedResponse) Status() string
Status returns HTTPResponse.Status
func (EnsureEverythingIsReferencedResponse) StatusCode ¶ added in v1.3.8
func (r EnsureEverythingIsReferencedResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type HttpRequestDoer ¶ added in v1.3.2
Doer performs HTTP requests.
The standard http.Client implements this interface.
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 ParamsWithAddPropsParams ¶ added in v1.2.0
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 ¶ added in v1.2.0
type ParamsWithAddPropsParams_P1 struct {
AdditionalProperties map[string]interface{} `json:"-"`
}
ParamsWithAddPropsParams_P1 defines parameters for ParamsWithAddProps.
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
ParamsWithAddPropsParams_P2_Inner defines parameters for ParamsWithAddProps.
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 ParamsWithAddPropsResponse ¶ added in v1.3.8
func ParseParamsWithAddPropsResponse ¶ added in v1.3.4
func ParseParamsWithAddPropsResponse(rsp *http.Response) (*ParamsWithAddPropsResponse, error)
ParseParamsWithAddPropsResponse parses an HTTP response from a ParamsWithAddPropsWithResponse call
func (ParamsWithAddPropsResponse) Status ¶ added in v1.3.8
func (r ParamsWithAddPropsResponse) Status() string
Status returns HTTPResponse.Status
func (ParamsWithAddPropsResponse) StatusCode ¶ added in v1.3.8
func (r ParamsWithAddPropsResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RequestBody ¶
type RequestBody struct {
Field SchemaObject `json:"Field"`
}
RequestBody defines model for RequestBody.
type RequestEditorFn ¶ added in v1.2.4
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 ¶
SchemaObject defines model for SchemaObject.
type ServerInterface ¶
type ServerInterface interface { // (GET /ensure-everything-is-referenced) EnsureEverythingIsReferenced(ctx echo.Context) error // (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) EnsureEverythingIsReferenced ¶ added in v1.3.7
func (w *ServerInterfaceWrapper) EnsureEverythingIsReferenced(ctx echo.Context) error
EnsureEverythingIsReferenced 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.