Documentation

Overview

    Package schemas provides primitives to interact the openapi HTTP API.

    Code generated by github.com/missmp/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 NewIssue30Request

      func NewIssue30Request(server string, pFallthrough string) (*http.Request, error)

        NewIssue30Request generates requests for Issue30

        func NewIssue41Request

        func NewIssue41Request(server string, n1param N5StartsWithNumber) (*http.Request, error)

          NewIssue41Request generates requests for Issue41

          func NewIssue9Request

          func NewIssue9Request(server string, params *Issue9Params, body Issue9JSONRequestBody) (*http.Request, error)

            NewIssue9Request calls the generic Issue9 builder with application/json body

            func NewIssue9RequestWithBody

            func NewIssue9RequestWithBody(server string, params *Issue9Params, contentType string, body io.Reader) (*http.Request, error)

              NewIssue9RequestWithBody generates requests for Issue9 with any type of body

              func ParseIssue30Response

              func ParseIssue30Response(rsp *http.Response) (*issue30Response, error)

                ParseIssue30Response parses an HTTP response from a Issue30WithResponse call

                func ParseIssue41Response

                func ParseIssue41Response(rsp *http.Response) (*issue41Response, error)

                  ParseIssue41Response parses an HTTP response from a Issue41WithResponse call

                  func ParseIssue9Response

                  func ParseIssue9Response(rsp *http.Response) (*issue9Response, error)

                    ParseIssue9Response parses an HTTP response from a Issue9WithResponse 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)

                      RegisterHandlers adds each server route to the EchoRouter.

                      Types

                      type AnyType1

                      type AnyType1 interface{}

                        AnyType1 defines model for AnyType1.

                        type AnyType2

                        type AnyType2 interface{}

                          AnyType2 defines model for AnyType2.

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

                              func (c *Client) Issue30(ctx context.Context, pFallthrough string) (*http.Response, error)

                              func (*Client) Issue41

                              func (c *Client) Issue41(ctx context.Context, n1param N5StartsWithNumber) (*http.Response, error)

                              func (*Client) Issue9

                              func (c *Client) Issue9(ctx context.Context, params *Issue9Params, body Issue9JSONRequestBody) (*http.Response, error)

                              func (*Client) Issue9WithBody

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

                              type ClientInterface

                              type ClientInterface interface {
                              	// Issue30 request
                              	Issue30(ctx context.Context, pFallthrough string) (*http.Response, error)
                              
                              	// Issue41 request
                              	Issue41(ctx context.Context, n1param N5StartsWithNumber) (*http.Response, error)
                              
                              	// Issue9 request  with any body
                              	Issue9WithBody(ctx context.Context, params *Issue9Params, contentType string, body io.Reader) (*http.Response, error)
                              
                              	Issue9(ctx context.Context, params *Issue9Params, body Issue9JSONRequestBody) (*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) Issue30WithResponse

                                            func (c *ClientWithResponses) Issue30WithResponse(ctx context.Context, pFallthrough string) (*issue30Response, error)

                                              Issue30WithResponse request returning *Issue30Response

                                              func (*ClientWithResponses) Issue41WithResponse

                                              func (c *ClientWithResponses) Issue41WithResponse(ctx context.Context, n1param N5StartsWithNumber) (*issue41Response, error)

                                                Issue41WithResponse request returning *Issue41Response

                                                func (*ClientWithResponses) Issue9WithBodyWithResponse

                                                func (c *ClientWithResponses) Issue9WithBodyWithResponse(ctx context.Context, params *Issue9Params, contentType string, body io.Reader) (*issue9Response, error)

                                                  Issue9WithBodyWithResponse request with arbitrary body returning *Issue9Response

                                                  func (*ClientWithResponses) Issue9WithResponse

                                                  func (c *ClientWithResponses) Issue9WithResponse(ctx context.Context, params *Issue9Params, body Issue9JSONRequestBody) (*issue9Response, error)

                                                  type CustomStringType

                                                  type CustomStringType string

                                                    CustomStringType defines model for CustomStringType.

                                                    type GenericObject

                                                    type GenericObject map[string]interface{}

                                                      GenericObject defines model for GenericObject.

                                                      type HttpRequestDoer

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

                                                        Doer performs HTTP requests.

                                                        The standard http.Client implements this interface.

                                                        type Issue9JSONBody

                                                        type Issue9JSONBody interface{}

                                                          Issue9JSONBody defines parameters for Issue9.

                                                          type Issue9JSONRequestBody

                                                          type Issue9JSONRequestBody Issue9JSONBody

                                                            Issue9RequestBody defines body for Issue9 for application/json ContentType.

                                                            type Issue9Params

                                                            type Issue9Params struct {
                                                            	Foo string `json:"foo"`
                                                            }

                                                              Issue9Params defines parameters for Issue9.

                                                              type N5StartsWithNumber

                                                              type N5StartsWithNumber map[string]interface{}

                                                                N5StartsWithNumber defines model for 5StartsWithNumber.

                                                                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 /issues/30/{fallthrough})
                                                                  	Issue30(ctx echo.Context, pFallthrough string) error
                                                                  
                                                                  	// (GET /issues/41/{1param})
                                                                  	Issue41(ctx echo.Context, n1param N5StartsWithNumber) error
                                                                  
                                                                  	// (GET /issues/9)
                                                                  	Issue9(ctx echo.Context, params Issue9Params) error
                                                                  }

                                                                    ServerInterface represents all server handlers.

                                                                    type ServerInterfaceWrapper

                                                                    type ServerInterfaceWrapper struct {
                                                                    	Handler ServerInterface
                                                                    }

                                                                      ServerInterfaceWrapper converts echo contexts to parameters.

                                                                      func (*ServerInterfaceWrapper) Issue30

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

                                                                        Issue30 converts echo context to params.

                                                                        func (*ServerInterfaceWrapper) Issue41

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

                                                                          Issue41 converts echo context to params.

                                                                          func (*ServerInterfaceWrapper) Issue9

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

                                                                            Issue9 converts echo context to params.