Documentation ¶
Overview ¶
Package client provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen DO NOT EDIT.
Index ¶
- Constants
- func GetSwagger() (*openapi3.Swagger, error)
- func NewGetBothRequest(server string) (*http.Request, error)
- func NewGetJsonRequest(server string) (*http.Request, error)
- func NewGetJsonWithTrailingSlashRequest(server string) (*http.Request, error)
- func NewGetOtherRequest(server string) (*http.Request, error)
- func NewPostBothRequest(server string, body PostBothJSONRequestBody) (*http.Request, error)
- func NewPostBothRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostJsonRequest(server string, body PostJsonJSONRequestBody) (*http.Request, error)
- func NewPostJsonRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func NewPostOtherRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
- func RegisterHandlers(router EchoRouter, si ServerInterface)
- func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)
- type Client
- func (c *Client) GetBoth(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetJson(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetJsonWithTrailingSlash(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetOther(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) PostBoth(ctx context.Context, body PostBothJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PostBothWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostJson(ctx context.Context, body PostJsonJSONRequestBody, ...) (*http.Response, error)
- func (c *Client) PostJsonWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) PostOtherWithBody(ctx context.Context, contentType string, body io.Reader, ...) (*http.Response, error)
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) GetBothWithResponse(ctx context.Context) (*GetBothResponse, error)
- func (c *ClientWithResponses) GetJsonWithResponse(ctx context.Context) (*GetJsonResponse, error)
- func (c *ClientWithResponses) GetJsonWithTrailingSlashWithResponse(ctx context.Context) (*GetJsonWithTrailingSlashResponse, error)
- func (c *ClientWithResponses) GetOtherWithResponse(ctx context.Context) (*GetOtherResponse, error)
- func (c *ClientWithResponses) PostBothWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*PostBothResponse, error)
- func (c *ClientWithResponses) PostBothWithResponse(ctx context.Context, body PostBothJSONRequestBody) (*PostBothResponse, error)
- func (c *ClientWithResponses) PostJsonWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*PostJsonResponse, error)
- func (c *ClientWithResponses) PostJsonWithResponse(ctx context.Context, body PostJsonJSONRequestBody) (*PostJsonResponse, error)
- func (c *ClientWithResponses) PostOtherWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*PostOtherResponse, error)
- type ClientWithResponsesInterface
- type EchoRouter
- type GetBothResponse
- type GetJsonResponse
- type GetJsonWithTrailingSlashResponse
- type GetOtherResponse
- type HttpRequestDoer
- type PostBothJSONBody
- type PostBothJSONRequestBody
- type PostBothResponse
- type PostJsonJSONBody
- type PostJsonJSONRequestBody
- type PostJsonResponse
- type PostOtherResponse
- type RequestEditorFn
- type SchemaObject
- type ServerInterface
- type ServerInterfaceWrapper
- func (w *ServerInterfaceWrapper) GetBoth(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetJson(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetJsonWithTrailingSlash(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) GetOther(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) PostBoth(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) PostJson(ctx echo.Context) error
- func (w *ServerInterfaceWrapper) PostOther(ctx echo.Context) error
Constants ¶
const (
OpenIdScopes = "OpenId.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func GetSwagger ¶
GetSwagger returns the Swagger specification corresponding to the generated code in this file.
func NewGetBothRequest ¶
NewGetBothRequest generates requests for GetBoth
func NewGetJsonRequest ¶
NewGetJsonRequest generates requests for GetJson
func NewGetJsonWithTrailingSlashRequest ¶ added in v1.3.4
NewGetJsonWithTrailingSlashRequest generates requests for GetJsonWithTrailingSlash
func NewGetOtherRequest ¶
NewGetOtherRequest generates requests for GetOther
func NewPostBothRequest ¶
func NewPostBothRequest(server string, body PostBothJSONRequestBody) (*http.Request, error)
NewPostBothRequest calls the generic PostBoth builder with application/json body
func NewPostBothRequestWithBody ¶
func NewPostBothRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewPostBothRequestWithBody generates requests for PostBoth with any type of body
func NewPostJsonRequest ¶
func NewPostJsonRequest(server string, body PostJsonJSONRequestBody) (*http.Request, error)
NewPostJsonRequest calls the generic PostJson builder with application/json body
func NewPostJsonRequestWithBody ¶
func NewPostJsonRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewPostJsonRequestWithBody generates requests for PostJson with any type of body
func NewPostOtherRequestWithBody ¶
func NewPostOtherRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)
NewPostOtherRequestWithBody generates requests for PostOther with any type of body
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 Client ¶
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) GetJsonWithTrailingSlash ¶ added in v1.3.4
func (*Client) PostBoth ¶
func (c *Client) PostBoth(ctx context.Context, body PostBothJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostBothWithBody ¶
func (*Client) PostJson ¶
func (c *Client) PostJson(ctx context.Context, body PostJsonJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
func (*Client) PostJsonWithBody ¶
type ClientInterface ¶
type ClientInterface interface { // PostBoth request with any body PostBothWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) PostBoth(ctx context.Context, body PostBothJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) // GetBoth request GetBoth(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error) // PostJson request with any body PostJsonWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) PostJson(ctx context.Context, body PostJsonJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) // GetJson request GetJson(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error) // PostOther request with any body PostOtherWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) // GetOther request GetOther(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error) // GetJsonWithTrailingSlash request GetJsonWithTrailingSlash(ctx context.Context, 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 ¶
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) GetBothWithResponse ¶
func (c *ClientWithResponses) GetBothWithResponse(ctx context.Context) (*GetBothResponse, error)
GetBothWithResponse request returning *GetBothResponse
func (*ClientWithResponses) GetJsonWithResponse ¶
func (c *ClientWithResponses) GetJsonWithResponse(ctx context.Context) (*GetJsonResponse, error)
GetJsonWithResponse request returning *GetJsonResponse
func (*ClientWithResponses) GetJsonWithTrailingSlashWithResponse ¶ added in v1.3.4
func (c *ClientWithResponses) GetJsonWithTrailingSlashWithResponse(ctx context.Context) (*GetJsonWithTrailingSlashResponse, error)
GetJsonWithTrailingSlashWithResponse request returning *GetJsonWithTrailingSlashResponse
func (*ClientWithResponses) GetOtherWithResponse ¶
func (c *ClientWithResponses) GetOtherWithResponse(ctx context.Context) (*GetOtherResponse, error)
GetOtherWithResponse request returning *GetOtherResponse
func (*ClientWithResponses) PostBothWithBodyWithResponse ¶
func (c *ClientWithResponses) PostBothWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*PostBothResponse, error)
PostBothWithBodyWithResponse request with arbitrary body returning *PostBothResponse
func (*ClientWithResponses) PostBothWithResponse ¶
func (c *ClientWithResponses) PostBothWithResponse(ctx context.Context, body PostBothJSONRequestBody) (*PostBothResponse, error)
func (*ClientWithResponses) PostJsonWithBodyWithResponse ¶
func (c *ClientWithResponses) PostJsonWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*PostJsonResponse, error)
PostJsonWithBodyWithResponse request with arbitrary body returning *PostJsonResponse
func (*ClientWithResponses) PostJsonWithResponse ¶
func (c *ClientWithResponses) PostJsonWithResponse(ctx context.Context, body PostJsonJSONRequestBody) (*PostJsonResponse, error)
func (*ClientWithResponses) PostOtherWithBodyWithResponse ¶
func (c *ClientWithResponses) PostOtherWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*PostOtherResponse, error)
PostOtherWithBodyWithResponse request with arbitrary body returning *PostOtherResponse
type ClientWithResponsesInterface ¶ added in v1.3.8
type ClientWithResponsesInterface interface { // PostBoth request with any body PostBothWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*PostBothResponse, error) PostBothWithResponse(ctx context.Context, body PostBothJSONRequestBody) (*PostBothResponse, error) // GetBoth request GetBothWithResponse(ctx context.Context) (*GetBothResponse, error) // PostJson request with any body PostJsonWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*PostJsonResponse, error) PostJsonWithResponse(ctx context.Context, body PostJsonJSONRequestBody) (*PostJsonResponse, error) // GetJson request GetJsonWithResponse(ctx context.Context) (*GetJsonResponse, error) // PostOther request with any body PostOtherWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader) (*PostOtherResponse, error) // GetOther request GetOtherWithResponse(ctx context.Context) (*GetOtherResponse, error) // GetJsonWithTrailingSlash request GetJsonWithTrailingSlashWithResponse(ctx context.Context) (*GetJsonWithTrailingSlashResponse, 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 GetBothResponse ¶ added in v1.3.8
func ParseGetBothResponse ¶ added in v1.3.4
func ParseGetBothResponse(rsp *http.Response) (*GetBothResponse, error)
ParseGetBothResponse parses an HTTP response from a GetBothWithResponse call
func (GetBothResponse) Status ¶ added in v1.3.8
func (r GetBothResponse) Status() string
Status returns HTTPResponse.Status
func (GetBothResponse) StatusCode ¶ added in v1.3.8
func (r GetBothResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetJsonResponse ¶ added in v1.3.8
func ParseGetJsonResponse ¶ added in v1.3.4
func ParseGetJsonResponse(rsp *http.Response) (*GetJsonResponse, error)
ParseGetJsonResponse parses an HTTP response from a GetJsonWithResponse call
func (GetJsonResponse) Status ¶ added in v1.3.8
func (r GetJsonResponse) Status() string
Status returns HTTPResponse.Status
func (GetJsonResponse) StatusCode ¶ added in v1.3.8
func (r GetJsonResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetJsonWithTrailingSlashResponse ¶ added in v1.3.8
func ParseGetJsonWithTrailingSlashResponse ¶ added in v1.3.4
func ParseGetJsonWithTrailingSlashResponse(rsp *http.Response) (*GetJsonWithTrailingSlashResponse, error)
ParseGetJsonWithTrailingSlashResponse parses an HTTP response from a GetJsonWithTrailingSlashWithResponse call
func (GetJsonWithTrailingSlashResponse) Status ¶ added in v1.3.8
func (r GetJsonWithTrailingSlashResponse) Status() string
Status returns HTTPResponse.Status
func (GetJsonWithTrailingSlashResponse) StatusCode ¶ added in v1.3.8
func (r GetJsonWithTrailingSlashResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetOtherResponse ¶ added in v1.3.8
func ParseGetOtherResponse ¶ added in v1.3.4
func ParseGetOtherResponse(rsp *http.Response) (*GetOtherResponse, error)
ParseGetOtherResponse parses an HTTP response from a GetOtherWithResponse call
func (GetOtherResponse) Status ¶ added in v1.3.8
func (r GetOtherResponse) Status() string
Status returns HTTPResponse.Status
func (GetOtherResponse) StatusCode ¶ added in v1.3.8
func (r GetOtherResponse) 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 PostBothJSONBody ¶ added in v1.3.0
type PostBothJSONBody SchemaObject
PostBothJSONBody defines parameters for PostBoth.
type PostBothJSONRequestBody ¶
type PostBothJSONRequestBody PostBothJSONBody
PostBothJSONRequestBody defines body for PostBoth for application/json ContentType.
type PostBothResponse ¶ added in v1.3.8
func ParsePostBothResponse ¶ added in v1.3.4
func ParsePostBothResponse(rsp *http.Response) (*PostBothResponse, error)
ParsePostBothResponse parses an HTTP response from a PostBothWithResponse call
func (PostBothResponse) Status ¶ added in v1.3.8
func (r PostBothResponse) Status() string
Status returns HTTPResponse.Status
func (PostBothResponse) StatusCode ¶ added in v1.3.8
func (r PostBothResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostJsonJSONBody ¶ added in v1.3.0
type PostJsonJSONBody SchemaObject
PostJsonJSONBody defines parameters for PostJson.
type PostJsonJSONRequestBody ¶
type PostJsonJSONRequestBody PostJsonJSONBody
PostJsonJSONRequestBody defines body for PostJson for application/json ContentType.
type PostJsonResponse ¶ added in v1.3.8
func ParsePostJsonResponse ¶ added in v1.3.4
func ParsePostJsonResponse(rsp *http.Response) (*PostJsonResponse, error)
ParsePostJsonResponse parses an HTTP response from a PostJsonWithResponse call
func (PostJsonResponse) Status ¶ added in v1.3.8
func (r PostJsonResponse) Status() string
Status returns HTTPResponse.Status
func (PostJsonResponse) StatusCode ¶ added in v1.3.8
func (r PostJsonResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type PostOtherResponse ¶ added in v1.3.8
func ParsePostOtherResponse ¶ added in v1.3.4
func ParsePostOtherResponse(rsp *http.Response) (*PostOtherResponse, error)
ParsePostOtherResponse parses an HTTP response from a PostOtherWithResponse call
func (PostOtherResponse) Status ¶ added in v1.3.8
func (r PostOtherResponse) Status() string
Status returns HTTPResponse.Status
func (PostOtherResponse) StatusCode ¶ added in v1.3.8
func (r PostOtherResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type RequestEditorFn ¶ added in v1.2.4
RequestEditorFn is the function signature for the RequestEditor callback function
type SchemaObject ¶
SchemaObject defines model for SchemaObject.
type ServerInterface ¶
type ServerInterface interface { // (POST /with_both_bodies) PostBoth(ctx echo.Context) error // (GET /with_both_responses) GetBoth(ctx echo.Context) error // (POST /with_json_body) PostJson(ctx echo.Context) error // (GET /with_json_response) GetJson(ctx echo.Context) error // (POST /with_other_body) PostOther(ctx echo.Context) error // (GET /with_other_response) GetOther(ctx echo.Context) error // (GET /with_trailing_slash/) GetJsonWithTrailingSlash(ctx echo.Context) error }
ServerInterface represents all server handlers.
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct {
Handler ServerInterface
}
ServerInterfaceWrapper converts echo contexts to parameters.
func (*ServerInterfaceWrapper) GetBoth ¶
func (w *ServerInterfaceWrapper) GetBoth(ctx echo.Context) error
GetBoth converts echo context to params.
func (*ServerInterfaceWrapper) GetJson ¶
func (w *ServerInterfaceWrapper) GetJson(ctx echo.Context) error
GetJson converts echo context to params.
func (*ServerInterfaceWrapper) GetJsonWithTrailingSlash ¶ added in v1.3.4
func (w *ServerInterfaceWrapper) GetJsonWithTrailingSlash(ctx echo.Context) error
GetJsonWithTrailingSlash converts echo context to params.
func (*ServerInterfaceWrapper) GetOther ¶
func (w *ServerInterfaceWrapper) GetOther(ctx echo.Context) error
GetOther converts echo context to params.
func (*ServerInterfaceWrapper) PostBoth ¶
func (w *ServerInterfaceWrapper) PostBoth(ctx echo.Context) error
PostBoth converts echo context to params.
func (*ServerInterfaceWrapper) PostJson ¶
func (w *ServerInterfaceWrapper) PostJson(ctx echo.Context) error
PostJson converts echo context to params.
func (*ServerInterfaceWrapper) PostOther ¶
func (w *ServerInterfaceWrapper) PostOther(ctx echo.Context) error
PostOther converts echo context to params.