schemas

package
v1.1.1 Latest Latest
Warning

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

 Go to latest Published: Oct 5, 2023 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

Package schemas provides primitives to interact with the openapi HTTP API.

Code generated by github.com/formatsocial/oapi-codegen version (devel) DO NOT EDIT.

Index

Constants

View Source 
const (
	Access_tokenScopes = "access_token.Scopes"
)

Variables

This section is empty.

Functions

func GetSwagger 

func GetSwagger() (swagger *openapi3.T, err error)

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 NewEnsureEverythingIsReferencedRequest 

func NewEnsureEverythingIsReferencedRequest(server string) (*http.Request, error)

NewEnsureEverythingIsReferencedRequest generates requests for EnsureEverythingIsReferenced

func NewGetIssues375Request 

func NewGetIssues375Request(server string) (*http.Request, error)

NewGetIssues375Request generates requests for GetIssues375

func NewIssue127Request 

func NewIssue127Request(server string) (*http.Request, error)

NewIssue127Request generates requests for Issue127

func NewIssue185Request 

func NewIssue185Request(server string, body Issue185JSONRequestBody) (*http.Request, error)

NewIssue185Request calls the generic Issue185 builder with application/json body

func NewIssue185RequestWithBody 

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

NewIssue185RequestWithBody generates requests for Issue185 with any type of body

func NewIssue209Request 

func NewIssue209Request(server string, str StringInPath) (*http.Request, error)

NewIssue209Request generates requests for Issue209

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 PathToRawSpec 

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

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 

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 AnyType1 

type AnyType1 = interface{}

AnyType1 defines model for AnyType1.

type AnyType2 

type AnyType2 = interface{}

AnyType2 AnyType2 represents any type.

This should be an interface{}

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 

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

Creates a new Client, with reasonable defaults

func (*Client) EnsureEverythingIsReferenced 

func (c *Client) EnsureEverythingIsReferenced(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetIssues375 

func (c *Client) GetIssues375(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Issue127 

func (c *Client) Issue127(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Issue185 

func (c *Client) Issue185(ctx context.Context, body Issue185JSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Issue185WithBody 

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

func (*Client) Issue209 

func (c *Client) Issue209(ctx context.Context, str StringInPath, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) Issue30 

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

func (*Client) Issue41 

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

func (*Client) Issue9 

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

func (*Client) Issue9WithBody 

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

type ClientInterface 

type ClientInterface interface {
	// EnsureEverythingIsReferenced request
	EnsureEverythingIsReferenced(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Issue127 request
	Issue127(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Issue185 request with any body
	Issue185WithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	Issue185(ctx context.Context, body Issue185JSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Issue209 request
	Issue209(ctx context.Context, str StringInPath, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Issue30 request
	Issue30(ctx context.Context, pFallthrough string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetIssues375 request
	GetIssues375(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Issue41 request
	Issue41(ctx context.Context, n1param N5StartsWithNumber, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Issue9 request with any body
	Issue9WithBody(ctx context.Context, params *Issue9Params, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	Issue9(ctx context.Context, params *Issue9Params, body Issue9JSONRequestBody, reqEditors ...RequestEditorFn) (*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) EnsureEverythingIsReferencedWithResponse 

func (c *ClientWithResponses) EnsureEverythingIsReferencedWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*EnsureEverythingIsReferencedResponse, error)

EnsureEverythingIsReferencedWithResponse request returning *EnsureEverythingIsReferencedResponse

func (*ClientWithResponses) GetIssues375WithResponse 

func (c *ClientWithResponses) GetIssues375WithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetIssues375Response, error)

GetIssues375WithResponse request returning *GetIssues375Response

func (*ClientWithResponses) Issue127WithResponse 

func (c *ClientWithResponses) Issue127WithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*Issue127Response, error)

Issue127WithResponse request returning *Issue127Response

func (*ClientWithResponses) Issue185WithBodyWithResponse 

func (c *ClientWithResponses) Issue185WithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*Issue185Response, error)

Issue185WithBodyWithResponse request with arbitrary body returning *Issue185Response

func (*ClientWithResponses) Issue185WithResponse 

func (c *ClientWithResponses) Issue185WithResponse(ctx context.Context, body Issue185JSONRequestBody, reqEditors ...RequestEditorFn) (*Issue185Response, error)

func (*ClientWithResponses) Issue209WithResponse 

func (c *ClientWithResponses) Issue209WithResponse(ctx context.Context, str StringInPath, reqEditors ...RequestEditorFn) (*Issue209Response, error)

Issue209WithResponse request returning *Issue209Response

func (*ClientWithResponses) Issue30WithResponse 

func (c *ClientWithResponses) Issue30WithResponse(ctx context.Context, pFallthrough string, reqEditors ...RequestEditorFn) (*Issue30Response, error)

Issue30WithResponse request returning *Issue30Response

func (*ClientWithResponses) Issue41WithResponse 

func (c *ClientWithResponses) Issue41WithResponse(ctx context.Context, n1param N5StartsWithNumber, reqEditors ...RequestEditorFn) (*Issue41Response, error)

Issue41WithResponse request returning *Issue41Response

func (*ClientWithResponses) Issue9WithBodyWithResponse 

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

Issue9WithBodyWithResponse request with arbitrary body returning *Issue9Response

func (*ClientWithResponses) Issue9WithResponse 

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

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// EnsureEverythingIsReferenced request
	EnsureEverythingIsReferencedWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*EnsureEverythingIsReferencedResponse, error)

	// Issue127 request
	Issue127WithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*Issue127Response, error)

	// Issue185 request with any body
	Issue185WithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*Issue185Response, error)

	Issue185WithResponse(ctx context.Context, body Issue185JSONRequestBody, reqEditors ...RequestEditorFn) (*Issue185Response, error)

	// Issue209 request
	Issue209WithResponse(ctx context.Context, str StringInPath, reqEditors ...RequestEditorFn) (*Issue209Response, error)

	// Issue30 request
	Issue30WithResponse(ctx context.Context, pFallthrough string, reqEditors ...RequestEditorFn) (*Issue30Response, error)

	// GetIssues375 request
	GetIssues375WithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetIssues375Response, error)

	// Issue41 request
	Issue41WithResponse(ctx context.Context, n1param N5StartsWithNumber, reqEditors ...RequestEditorFn) (*Issue41Response, error)

	// Issue9 request with any body
	Issue9WithBodyWithResponse(ctx context.Context, params *Issue9Params, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*Issue9Response, error)

	Issue9WithResponse(ctx context.Context, params *Issue9Params, body Issue9JSONRequestBody, reqEditors ...RequestEditorFn) (*Issue9Response, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CustomStringType 

type CustomStringType = string

CustomStringType defines model for CustomStringType.

type EchoRouter 

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 EnsureEverythingIsReferencedResponse 

type EnsureEverythingIsReferencedResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		AnyType1 *AnyType1 `json:"anyType1,omitempty"`

		// AnyType2 AnyType2 represents any type.
		//
		// This should be an interface{}
		AnyType2         *AnyType2         `json:"anyType2,omitempty"`
		CustomStringType *CustomStringType `foo:"bar" json:"customStringType,omitempty"`
	}
}

func ParseEnsureEverythingIsReferencedResponse 

func ParseEnsureEverythingIsReferencedResponse(rsp *http.Response) (*EnsureEverythingIsReferencedResponse, error)

ParseEnsureEverythingIsReferencedResponse parses an HTTP response from a EnsureEverythingIsReferencedWithResponse call

func (EnsureEverythingIsReferencedResponse) Status 

func (r EnsureEverythingIsReferencedResponse) Status() string

Status returns HTTPResponse.Status

func (EnsureEverythingIsReferencedResponse) StatusCode 

func (r EnsureEverythingIsReferencedResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EnumInObjInArray 

type EnumInObjInArray = []struct {
	Val *EnumInObjInArrayVal `json:"val,omitempty"`
}

EnumInObjInArray defines model for EnumInObjInArray.

type EnumInObjInArrayVal 

type EnumInObjInArrayVal string

EnumInObjInArrayVal defines model for EnumInObjInArray.Val. 

const (
	First  EnumInObjInArrayVal = "first"
	Second EnumInObjInArrayVal = "second"
)

Defines values for EnumInObjInArrayVal.

type GenericObject 

type GenericObject = map[string]interface{}

GenericObject defines model for GenericObject.

type GetIssues375Response 

type GetIssues375Response struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *EnumInObjInArray
}

func ParseGetIssues375Response 

func ParseGetIssues375Response(rsp *http.Response) (*GetIssues375Response, error)

ParseGetIssues375Response parses an HTTP response from a GetIssues375WithResponse call

func (GetIssues375Response) Status 

func (r GetIssues375Response) Status() string

Status returns HTTPResponse.Status

func (GetIssues375Response) StatusCode 

func (r GetIssues375Response) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer 

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type Issue127Response 

type Issue127Response struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *GenericObject
	XML200       *GenericObject
	YAML200      *GenericObject
	JSONDefault  *GenericObject
}

func ParseIssue127Response 

func ParseIssue127Response(rsp *http.Response) (*Issue127Response, error)

ParseIssue127Response parses an HTTP response from a Issue127WithResponse call

func (Issue127Response) Status 

func (r Issue127Response) Status() string

Status returns HTTPResponse.Status

func (Issue127Response) StatusCode 

func (r Issue127Response) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Issue185JSONRequestBody 

type Issue185JSONRequestBody = NullableProperties

Issue185JSONRequestBody defines body for Issue185 for application/json ContentType.

type Issue185Response 

type Issue185Response struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseIssue185Response 

func ParseIssue185Response(rsp *http.Response) (*Issue185Response, error)

ParseIssue185Response parses an HTTP response from a Issue185WithResponse call

func (Issue185Response) Status 

func (r Issue185Response) Status() string

Status returns HTTPResponse.Status

func (Issue185Response) StatusCode 

func (r Issue185Response) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Issue209Response 

type Issue209Response struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseIssue209Response 

func ParseIssue209Response(rsp *http.Response) (*Issue209Response, error)

ParseIssue209Response parses an HTTP response from a Issue209WithResponse call

func (Issue209Response) Status 

func (r Issue209Response) Status() string

Status returns HTTPResponse.Status

func (Issue209Response) StatusCode 

func (r Issue209Response) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Issue30Response 

type Issue30Response struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseIssue30Response 

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

ParseIssue30Response parses an HTTP response from a Issue30WithResponse call

func (Issue30Response) Status 

func (r Issue30Response) Status() string

Status returns HTTPResponse.Status

func (Issue30Response) StatusCode 

func (r Issue30Response) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Issue41Response 

type Issue41Response struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseIssue41Response 

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

ParseIssue41Response parses an HTTP response from a Issue41WithResponse call

func (Issue41Response) Status 

func (r Issue41Response) Status() string

Status returns HTTPResponse.Status

func (Issue41Response) StatusCode 

func (r Issue41Response) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Issue9JSONBody 

type Issue9JSONBody = interface{}

Issue9JSONBody defines parameters for Issue9.

type Issue9JSONRequestBody 

type Issue9JSONRequestBody = Issue9JSONBody

Issue9JSONRequestBody defines body for Issue9 for application/json ContentType.

type Issue9Params 

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

Issue9Params defines parameters for Issue9.

type Issue9Response 

type Issue9Response struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseIssue9Response 

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

ParseIssue9Response parses an HTTP response from a Issue9WithResponse call

func (Issue9Response) Status 

func (r Issue9Response) Status() string

Status returns HTTPResponse.Status

func (Issue9Response) StatusCode 

func (r Issue9Response) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type N5StartsWithNumber 

type N5StartsWithNumber = map[string]interface{}

N5StartsWithNumber This schema name starts with a number

type NullableProperties 

type NullableProperties struct {
	Optional            *string `json:"optional,omitempty"`
	OptionalAndNullable *string `json:"optionalAndNullable"`
	Required            string  `json:"required"`
	RequiredAndNullable *string `json:"requiredAndNullable"`
}

NullableProperties defines model for NullableProperties.

type RequestEditorFn 

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

RequestEditorFn is the function signature for the RequestEditor callback function

type ServerInterface 

type ServerInterface interface {

	// (GET /ensure-everything-is-referenced)
	EnsureEverythingIsReferenced(ctx echo.Context) error

	// (GET /issues/127)
	Issue127(ctx echo.Context) error

	// (GET /issues/185)
	Issue185(ctx echo.Context) error

	// (GET /issues/209/${str})
	Issue209(ctx echo.Context, str StringInPath) error

	// (GET /issues/30/{fallthrough})
	Issue30(ctx echo.Context, pFallthrough string) error

	// (GET /issues/375)
	GetIssues375(ctx echo.Context) 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) EnsureEverythingIsReferenced 

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

EnsureEverythingIsReferenced converts echo context to params.

func (*ServerInterfaceWrapper) GetIssues375 

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

GetIssues375 converts echo context to params.

func (*ServerInterfaceWrapper) Issue127 

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

Issue127 converts echo context to params.

func (*ServerInterfaceWrapper) Issue185 

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

Issue185 converts echo context to params.

func (*ServerInterfaceWrapper) Issue209 

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

Issue209 converts echo context to params.

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.

type StringInPath 

type StringInPath = string

StringInPath defines model for StringInPath.

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.