operations

package
v0.0.0-...-18433b1 Latest Latest
Warning

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

 Go to latest Published: Sep 30, 2021 License: MIT Imports: 17 Imported by: 0

Documentation

Index

Constants

View Source 
const GetTokensIDNotFoundCode int = 404

GetTokensIDNotFoundCode is the HTTP code returned for type GetTokensIDNotFound

View Source 
const GetTokensIDOKCode int = 200

GetTokensIDOKCode is the HTTP code returned for type GetTokensIDOK

View Source 
const GetTokensOKCode int = 200

GetTokensOKCode is the HTTP code returned for type GetTokensOK

View Source 
const PostTokensCreatedCode int = 201

PostTokensCreatedCode is the HTTP code returned for type PostTokensCreated

Variables

This section is empty.

Functions

This section is empty.

Types

type GetTokens 

type GetTokens struct {
	Context *middleware.Context
	Handler GetTokensHandler
}
GetTokens swagger:route GET /tokens getTokens

Your GET endpoint

Get a list of retirment tokens

func NewGetTokens 

func NewGetTokens(ctx *middleware.Context, handler GetTokensHandler) *GetTokens

NewGetTokens creates a new http.Handler for the get tokens operation

func (*GetTokens) ServeHTTP 

func (o *GetTokens) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type GetTokensHandler 

type GetTokensHandler interface {
	Handle(GetTokensParams) middleware.Responder
}

GetTokensHandler interface for that can handle valid get tokens params

type GetTokensHandlerFunc 

type GetTokensHandlerFunc func(GetTokensParams) middleware.Responder

GetTokensHandlerFunc turns a function with the right signature into a get tokens handler

func (GetTokensHandlerFunc) Handle 

func (fn GetTokensHandlerFunc) Handle(params GetTokensParams) middleware.Responder

Handle executing the request and returning a response

type GetTokensID 

type GetTokensID struct {
	Context *middleware.Context
	Handler GetTokensIDHandler
}
GetTokensID swagger:route GET /tokens/{id} getTokensId

Your GET endpoint

Get a token by id

func NewGetTokensID 

func NewGetTokensID(ctx *middleware.Context, handler GetTokensIDHandler) *GetTokensID

NewGetTokensID creates a new http.Handler for the get tokens id operation

func (*GetTokensID) ServeHTTP 

func (o *GetTokensID) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type GetTokensIDHandler 

type GetTokensIDHandler interface {
	Handle(GetTokensIDParams) middleware.Responder
}

GetTokensIDHandler interface for that can handle valid get tokens id params

type GetTokensIDHandlerFunc 

type GetTokensIDHandlerFunc func(GetTokensIDParams) middleware.Responder

GetTokensIDHandlerFunc turns a function with the right signature into a get tokens id handler

func (GetTokensIDHandlerFunc) Handle 

func (fn GetTokensIDHandlerFunc) Handle(params GetTokensIDParams) middleware.Responder

Handle executing the request and returning a response

type GetTokensIDNotFound 

type GetTokensIDNotFound struct {

	/*
	  In: Body
	*/
	Payload interface{} `json:"body,omitempty"`
}

GetTokensIDNotFound Not Found

swagger:response getTokensIdNotFound

func NewGetTokensIDNotFound 

func NewGetTokensIDNotFound() *GetTokensIDNotFound

NewGetTokensIDNotFound creates GetTokensIDNotFound with default headers values

func (*GetTokensIDNotFound) SetPayload 

func (o *GetTokensIDNotFound) SetPayload(payload interface{})

SetPayload sets the payload to the get tokens Id not found response

func (*GetTokensIDNotFound) WithPayload 

func (o *GetTokensIDNotFound) WithPayload(payload interface{}) *GetTokensIDNotFound

WithPayload adds the payload to the get tokens Id not found response

func (*GetTokensIDNotFound) WriteResponse 

func (o *GetTokensIDNotFound) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type GetTokensIDOK 

type GetTokensIDOK struct {

	/*
	  In: Body
	*/
	Payload interface{} `json:"body,omitempty"`
}

GetTokensIDOK OK

swagger:response getTokensIdOK

func NewGetTokensIDOK 

func NewGetTokensIDOK() *GetTokensIDOK

NewGetTokensIDOK creates GetTokensIDOK with default headers values

func (*GetTokensIDOK) SetPayload 

func (o *GetTokensIDOK) SetPayload(payload interface{})

SetPayload sets the payload to the get tokens Id o k response

func (*GetTokensIDOK) WithPayload 

func (o *GetTokensIDOK) WithPayload(payload interface{}) *GetTokensIDOK

WithPayload adds the payload to the get tokens Id o k response

func (*GetTokensIDOK) WriteResponse 

func (o *GetTokensIDOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type GetTokensIDParams 

type GetTokensIDParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*Coin ID
	  Required: true
	  In: path
	*/
	ID string
}

GetTokensIDParams contains all the bound params for the get tokens id operation typically these are obtained from a http.Request

swagger:parameters get-tokens-id

func NewGetTokensIDParams 

func NewGetTokensIDParams() GetTokensIDParams

NewGetTokensIDParams creates a new GetTokensIDParams object

There are no default values defined in the spec.

func (*GetTokensIDParams) BindRequest 

func (o *GetTokensIDParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewGetTokensIDParams() beforehand.

type GetTokensIDURL 

type GetTokensIDURL struct {
	ID string
	// contains filtered or unexported fields
}

GetTokensIDURL generates an URL for the get tokens id operation

func (*GetTokensIDURL) Build 

func (o *GetTokensIDURL) Build() (*url.URL, error)

Build a url path and query string

func (*GetTokensIDURL) BuildFull 

func (o *GetTokensIDURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*GetTokensIDURL) Must 

func (o *GetTokensIDURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*GetTokensIDURL) SetBasePath 

func (o *GetTokensIDURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*GetTokensIDURL) String 

func (o *GetTokensIDURL) String() string

String returns the string representation of the path with query string

func (*GetTokensIDURL) StringFull 

func (o *GetTokensIDURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*GetTokensIDURL) WithBasePath 

func (o *GetTokensIDURL) WithBasePath(bp string) *GetTokensIDURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

type GetTokensOK 

type GetTokensOK struct {

	/*
	  In: Body
	*/
	Payload []*GetTokensOKBodyItems0 `json:"body,omitempty"`
}

GetTokensOK OK

swagger:response getTokensOK

func NewGetTokensOK 

func NewGetTokensOK() *GetTokensOK

NewGetTokensOK creates GetTokensOK with default headers values

func (*GetTokensOK) SetPayload 

func (o *GetTokensOK) SetPayload(payload []*GetTokensOKBodyItems0)

SetPayload sets the payload to the get tokens o k response

func (*GetTokensOK) WithPayload 

func (o *GetTokensOK) WithPayload(payload []*GetTokensOKBodyItems0) *GetTokensOK

WithPayload adds the payload to the get tokens o k response

func (*GetTokensOK) WriteResponse 

func (o *GetTokensOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type GetTokensOKBodyItems0 

type GetTokensOKBodyItems0 struct {

	// id
	// Required: true
	ID *float64 `json:"id"`

	models.RetirementToken
}

GetTokensOKBodyItems0 get tokens o k body items0

swagger:model GetTokensOKBodyItems0

func (*GetTokensOKBodyItems0) ContextValidate 

func (o *GetTokensOKBodyItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this get tokens o k body items0 based on the context it is used

func (*GetTokensOKBodyItems0) MarshalBinary 

func (o *GetTokensOKBodyItems0) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (GetTokensOKBodyItems0) MarshalJSON 

func (o GetTokensOKBodyItems0) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

func (*GetTokensOKBodyItems0) UnmarshalBinary 

func (o *GetTokensOKBodyItems0) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GetTokensOKBodyItems0) UnmarshalJSON 

func (o *GetTokensOKBodyItems0) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

func (*GetTokensOKBodyItems0) Validate 

func (o *GetTokensOKBodyItems0) Validate(formats strfmt.Registry) error

Validate validates this get tokens o k body items0

type GetTokensParams 

type GetTokensParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`
}

GetTokensParams contains all the bound params for the get tokens operation typically these are obtained from a http.Request

swagger:parameters get-tokens

func NewGetTokensParams 

func NewGetTokensParams() GetTokensParams

NewGetTokensParams creates a new GetTokensParams object

There are no default values defined in the spec.

func (*GetTokensParams) BindRequest 

func (o *GetTokensParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewGetTokensParams() beforehand.

type GetTokensURL 

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

GetTokensURL generates an URL for the get tokens operation

func (*GetTokensURL) Build 

func (o *GetTokensURL) Build() (*url.URL, error)

Build a url path and query string

func (*GetTokensURL) BuildFull 

func (o *GetTokensURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*GetTokensURL) Must 

func (o *GetTokensURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*GetTokensURL) SetBasePath 

func (o *GetTokensURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*GetTokensURL) String 

func (o *GetTokensURL) String() string

String returns the string representation of the path with query string

func (*GetTokensURL) StringFull 

func (o *GetTokensURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*GetTokensURL) WithBasePath 

func (o *GetTokensURL) WithBasePath(bp string) *GetTokensURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

type PostTokens 

type PostTokens struct {
	Context *middleware.Context
	Handler PostTokensHandler
}
PostTokens swagger:route POST /tokens postTokens

Create Retirement Token

Create a retirement token

func NewPostTokens 

func NewPostTokens(ctx *middleware.Context, handler PostTokensHandler) *PostTokens

NewPostTokens creates a new http.Handler for the post tokens operation

func (*PostTokens) ServeHTTP 

func (o *PostTokens) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type PostTokensCreated 

type PostTokensCreated struct {

	/*
	  In: Body
	*/
	Payload interface{} `json:"body,omitempty"`
}

PostTokensCreated Created

swagger:response postTokensCreated

func NewPostTokensCreated 

func NewPostTokensCreated() *PostTokensCreated

NewPostTokensCreated creates PostTokensCreated with default headers values

func (*PostTokensCreated) SetPayload 

func (o *PostTokensCreated) SetPayload(payload interface{})

SetPayload sets the payload to the post tokens created response

func (*PostTokensCreated) WithPayload 

func (o *PostTokensCreated) WithPayload(payload interface{}) *PostTokensCreated

WithPayload adds the payload to the post tokens created response

func (*PostTokensCreated) WriteResponse 

func (o *PostTokensCreated) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type PostTokensHandler 

type PostTokensHandler interface {
	Handle(PostTokensParams) middleware.Responder
}

PostTokensHandler interface for that can handle valid post tokens params

type PostTokensHandlerFunc 

type PostTokensHandlerFunc func(PostTokensParams) middleware.Responder

PostTokensHandlerFunc turns a function with the right signature into a post tokens handler

func (PostTokensHandlerFunc) Handle 

func (fn PostTokensHandlerFunc) Handle(params PostTokensParams) middleware.Responder

Handle executing the request and returning a response

type PostTokensParams 

type PostTokensParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`

	/*
	  In: body
	*/
	Body *models.RetirementToken
}

PostTokensParams contains all the bound params for the post tokens operation typically these are obtained from a http.Request

swagger:parameters post-tokens

func NewPostTokensParams 

func NewPostTokensParams() PostTokensParams

NewPostTokensParams creates a new PostTokensParams object

There are no default values defined in the spec.

func (*PostTokensParams) BindRequest 

func (o *PostTokensParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewPostTokensParams() beforehand.

type PostTokensURL 

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

PostTokensURL generates an URL for the post tokens operation

func (*PostTokensURL) Build 

func (o *PostTokensURL) Build() (*url.URL, error)

Build a url path and query string

func (*PostTokensURL) BuildFull 

func (o *PostTokensURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*PostTokensURL) Must 

func (o *PostTokensURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*PostTokensURL) SetBasePath 

func (o *PostTokensURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*PostTokensURL) String 

func (o *PostTokensURL) String() string

String returns the string representation of the path with query string

func (*PostTokensURL) StringFull 

func (o *PostTokensURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*PostTokensURL) WithBasePath 

func (o *PostTokensURL) WithBasePath(bp string) *PostTokensURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

type RetirementTokensAPI 

type RetirementTokensAPI struct {
	Middleware func(middleware.Builder) http.Handler

	// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator

	// APIKeyAuthenticator generates a runtime.Authenticator from the supplied token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator

	// BearerAuthenticator generates a runtime.Authenticator from the supplied bearer token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator

	// JSONConsumer registers a consumer for the following mime types:
	//   - application/json
	JSONConsumer runtime.Consumer

	// JSONProducer registers a producer for the following mime types:
	//   - application/json
	JSONProducer runtime.Producer

	// GetTokensHandler sets the operation handler for the get tokens operation
	GetTokensHandler GetTokensHandler
	// GetTokensIDHandler sets the operation handler for the get tokens id operation
	GetTokensIDHandler GetTokensIDHandler
	// PostTokensHandler sets the operation handler for the post tokens operation
	PostTokensHandler PostTokensHandler

	// ServeError is called when an error is received, there is a default handler
	// but you can set your own with this
	ServeError func(http.ResponseWriter, *http.Request, error)

	// PreServerShutdown is called before the HTTP(S) server is shutdown
	// This allows for custom functions to get executed before the HTTP(S) server stops accepting traffic
	PreServerShutdown func()

	// ServerShutdown is called when the HTTP(S) server is shut down and done
	// handling all active connections and does not accept connections any more
	ServerShutdown func()

	// Custom command line argument groups with their descriptions
	CommandLineOptionsGroups []swag.CommandLineOptionsGroup

	// User defined logger function.
	Logger func(string, ...interface{})
	// contains filtered or unexported fields
}

RetirementTokensAPI the retirement tokens API

func NewRetirementTokensAPI 

func NewRetirementTokensAPI(spec *loads.Document) *RetirementTokensAPI

NewRetirementTokensAPI creates a new RetirementTokens instance

func (*RetirementTokensAPI) AddMiddlewareFor 

func (o *RetirementTokensAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)

AddMiddlewareFor adds a http middleware to existing handler

func (*RetirementTokensAPI) AuthenticatorsFor 

func (o *RetirementTokensAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*RetirementTokensAPI) Authorizer 

func (o *RetirementTokensAPI) Authorizer() runtime.Authorizer

Authorizer returns the registered authorizer

func (*RetirementTokensAPI) ConsumersFor 

func (o *RetirementTokensAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer

ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.

func (*RetirementTokensAPI) Context 

func (o *RetirementTokensAPI) Context() *middleware.Context

Context returns the middleware context for the retirement tokens API

func (*RetirementTokensAPI) DefaultConsumes 

func (o *RetirementTokensAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*RetirementTokensAPI) DefaultProduces 

func (o *RetirementTokensAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*RetirementTokensAPI) Formats 

func (o *RetirementTokensAPI) Formats() strfmt.Registry

Formats returns the registered string formats

func (*RetirementTokensAPI) HandlerFor 

func (o *RetirementTokensAPI) HandlerFor(method, path string) (http.Handler, bool)

HandlerFor gets a http.Handler for the provided operation method and path

func (*RetirementTokensAPI) Init 

func (o *RetirementTokensAPI) Init()

Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit

func (*RetirementTokensAPI) ProducersFor 

func (o *RetirementTokensAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer

ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.

func (*RetirementTokensAPI) RegisterConsumer 

func (o *RetirementTokensAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)

RegisterConsumer allows you to add (or override) a consumer for a media type.

func (*RetirementTokensAPI) RegisterFormat 

func (o *RetirementTokensAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)

RegisterFormat registers a custom format validator

func (*RetirementTokensAPI) RegisterProducer 

func (o *RetirementTokensAPI) RegisterProducer(mediaType string, producer runtime.Producer)

RegisterProducer allows you to add (or override) a producer for a media type.

func (*RetirementTokensAPI) Serve 

func (o *RetirementTokensAPI) Serve(builder middleware.Builder) http.Handler

Serve creates a http handler to serve the API over HTTP can be used directly in http.ListenAndServe(":8000", api.Serve(nil))

func (*RetirementTokensAPI) ServeErrorFor 

func (o *RetirementTokensAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)

ServeErrorFor gets a error handler for a given operation id

func (*RetirementTokensAPI) SetDefaultConsumes 

func (o *RetirementTokensAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*RetirementTokensAPI) SetDefaultProduces 

func (o *RetirementTokensAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*RetirementTokensAPI) SetSpec 

func (o *RetirementTokensAPI) SetSpec(spec *loads.Document)

SetSpec sets a spec that will be served for the clients.

func (*RetirementTokensAPI) UseRedoc 

func (o *RetirementTokensAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*RetirementTokensAPI) UseSwaggerUI 

func (o *RetirementTokensAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*RetirementTokensAPI) Validate 

func (o *RetirementTokensAPI) Validate() error

Validate validates the registrations in the RetirementTokensAPI

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.