operations

package
v0.0.0-...-a73ce49 Latest Latest
Warning

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

 Go to latest Published: Dec 9, 2022 License: MIT Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
const GetOKCode int = 200

GetOKCode is the HTTP code returned for type GetOK

View Source 
const GetUUIDVersionInternalServerErrorCode int = 500

GetUUIDVersionInternalServerErrorCode is the HTTP code returned for type GetUUIDVersionInternalServerError

View Source 
const GetUUIDVersionOKCode int = 200

GetUUIDVersionOKCode is the HTTP code returned for type GetUUIDVersionOK

Variables

This section is empty.

Functions

This section is empty.

Types

type Get 

type Get struct {
	Context *middleware.Context
	Handler GetHandler
}
Get swagger:route GET / get

readiness check

readiness check

func NewGet 

func NewGet(ctx *middleware.Context, handler GetHandler) *Get

NewGet creates a new http.Handler for the get operation

func (*Get) ServeHTTP 

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

type GetHandler 

type GetHandler interface {
	Handle(GetParams) middleware.Responder
}

GetHandler interface for that can handle valid get params

type GetHandlerFunc 

type GetHandlerFunc func(GetParams) middleware.Responder

GetHandlerFunc turns a function with the right signature into a get handler

func (GetHandlerFunc) Handle 

func (fn GetHandlerFunc) Handle(params GetParams) middleware.Responder

Handle executing the request and returning a response

type GetOK 

type GetOK struct {
}

GetOK Success

swagger:response getOK

func NewGetOK 

func NewGetOK() *GetOK

NewGetOK creates GetOK with default headers values

func (*GetOK) WriteResponse 

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

WriteResponse to the client

type GetParams 

type GetParams struct {

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

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

swagger:parameters Get

func NewGetParams 

func NewGetParams() GetParams

NewGetParams creates a new GetParams object

There are no default values defined in the spec.

func (*GetParams) BindRequest 

func (o *GetParams) 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 NewGetParams() beforehand.

type GetURL 

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

GetURL generates an URL for the get operation

func (*GetURL) Build 

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

Build a url path and query string

func (*GetURL) BuildFull 

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

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

func (*GetURL) Must 

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

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

func (*GetURL) SetBasePath 

func (o *GetURL) 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 (*GetURL) String 

func (o *GetURL) String() string

String returns the string representation of the path with query string

func (*GetURL) StringFull 

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

StringFull returns the string representation of a complete url

func (*GetURL) WithBasePath 

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

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 GetUUIDVersion 

type GetUUIDVersion struct {
	Context *middleware.Context
	Handler GetUUIDVersionHandler
}
GetUUIDVersion swagger:route GET /uuid/{version} getUuidVersion

Get a uuid

A single UUID

func NewGetUUIDVersion 

func NewGetUUIDVersion(ctx *middleware.Context, handler GetUUIDVersionHandler) *GetUUIDVersion

NewGetUUIDVersion creates a new http.Handler for the get UUID version operation

func (*GetUUIDVersion) ServeHTTP 

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

type GetUUIDVersionHandler 

type GetUUIDVersionHandler interface {
	Handle(GetUUIDVersionParams) middleware.Responder
}

GetUUIDVersionHandler interface for that can handle valid get UUID version params

type GetUUIDVersionHandlerFunc 

type GetUUIDVersionHandlerFunc func(GetUUIDVersionParams) middleware.Responder

GetUUIDVersionHandlerFunc turns a function with the right signature into a get UUID version handler

func (GetUUIDVersionHandlerFunc) Handle 

func (fn GetUUIDVersionHandlerFunc) Handle(params GetUUIDVersionParams) middleware.Responder

Handle executing the request and returning a response

type GetUUIDVersionInternalServerError 

type GetUUIDVersionInternalServerError struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
}

GetUUIDVersionInternalServerError Error

swagger:response getUuidVersionInternalServerError

func NewGetUUIDVersionInternalServerError 

func NewGetUUIDVersionInternalServerError() *GetUUIDVersionInternalServerError

NewGetUUIDVersionInternalServerError creates GetUUIDVersionInternalServerError with default headers values

func (*GetUUIDVersionInternalServerError) SetPayload 

func (o *GetUUIDVersionInternalServerError) SetPayload(payload *models.Error)

SetPayload sets the payload to the get Uuid version internal server error response

func (*GetUUIDVersionInternalServerError) WithPayload 

func (o *GetUUIDVersionInternalServerError) WithPayload(payload *models.Error) *GetUUIDVersionInternalServerError

WithPayload adds the payload to the get Uuid version internal server error response

func (*GetUUIDVersionInternalServerError) WriteResponse 

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

WriteResponse to the client

type GetUUIDVersionOK 

type GetUUIDVersionOK struct {

	/*
	  In: Body
	*/
	Payload *models.GetUUIDResponse `json:"body,omitempty"`
}

GetUUIDVersionOK Successfully return a uuid

swagger:response getUuidVersionOK

func NewGetUUIDVersionOK 

func NewGetUUIDVersionOK() *GetUUIDVersionOK

NewGetUUIDVersionOK creates GetUUIDVersionOK with default headers values

func (*GetUUIDVersionOK) SetPayload 

func (o *GetUUIDVersionOK) SetPayload(payload *models.GetUUIDResponse)

SetPayload sets the payload to the get Uuid version o k response

func (*GetUUIDVersionOK) WithPayload 

func (o *GetUUIDVersionOK) WithPayload(payload *models.GetUUIDResponse) *GetUUIDVersionOK

WithPayload adds the payload to the get Uuid version o k response

func (*GetUUIDVersionOK) WriteResponse 

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

WriteResponse to the client

type GetUUIDVersionParams 

type GetUUIDVersionParams struct {

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

	/*A name string for UUID V3

	  In: query
	*/
	Name *string
	/*Predefined UUID for a V3 UUID

	  In: query
	*/
	UUID *string
	/*UUID version

	  Required: true
	  In: path
	*/
	Version string
}

GetUUIDVersionParams contains all the bound params for the get UUID version operation typically these are obtained from a http.Request

swagger:parameters GetUUIDVersion

func NewGetUUIDVersionParams 

func NewGetUUIDVersionParams() GetUUIDVersionParams

NewGetUUIDVersionParams creates a new GetUUIDVersionParams object

There are no default values defined in the spec.

func (*GetUUIDVersionParams) BindRequest 

func (o *GetUUIDVersionParams) 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 NewGetUUIDVersionParams() beforehand.

type GetUUIDVersionURL 

type GetUUIDVersionURL struct {
	Version string

	Name *string
	UUID *string
	// contains filtered or unexported fields
}

GetUUIDVersionURL generates an URL for the get UUID version operation

func (*GetUUIDVersionURL) Build 

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

Build a url path and query string

func (*GetUUIDVersionURL) BuildFull 

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

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

func (*GetUUIDVersionURL) Must 

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

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

func (*GetUUIDVersionURL) SetBasePath 

func (o *GetUUIDVersionURL) 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 (*GetUUIDVersionURL) String 

func (o *GetUUIDVersionURL) String() string

String returns the string representation of the path with query string

func (*GetUUIDVersionURL) StringFull 

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

StringFull returns the string representation of a complete url

func (*GetUUIDVersionURL) WithBasePath 

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

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 UUIDGenAPI 

type UUIDGenAPI 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

	// GetHandler sets the operation handler for the get operation
	GetHandler GetHandler
	// GetUUIDVersionHandler sets the operation handler for the get UUID version operation
	GetUUIDVersionHandler GetUUIDVersionHandler

	// 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
}

UUIDGenAPI Generates one or more UUIDs

func NewUUIDGenAPI 

func NewUUIDGenAPI(spec *loads.Document) *UUIDGenAPI

NewUUIDGenAPI creates a new UUIDGen instance

func (*UUIDGenAPI) AddMiddlewareFor 

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

AddMiddlewareFor adds a http middleware to existing handler

func (*UUIDGenAPI) AuthenticatorsFor 

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*UUIDGenAPI) Authorizer 

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

Authorizer returns the registered authorizer

func (*UUIDGenAPI) ConsumersFor 

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

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

func (*UUIDGenAPI) Context 

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

Context returns the middleware context for the UUID gen API

func (*UUIDGenAPI) DefaultConsumes 

func (o *UUIDGenAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*UUIDGenAPI) DefaultProduces 

func (o *UUIDGenAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*UUIDGenAPI) Formats 

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

Formats returns the registered string formats

func (*UUIDGenAPI) HandlerFor 

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

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

func (*UUIDGenAPI) Init 

func (o *UUIDGenAPI) Init()

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

func (*UUIDGenAPI) ProducersFor 

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

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

func (*UUIDGenAPI) RegisterConsumer 

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

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

func (*UUIDGenAPI) RegisterFormat 

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

RegisterFormat registers a custom format validator

func (*UUIDGenAPI) RegisterProducer 

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

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

func (*UUIDGenAPI) Serve 

func (o *UUIDGenAPI) 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 (*UUIDGenAPI) ServeErrorFor 

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

ServeErrorFor gets a error handler for a given operation id

func (*UUIDGenAPI) SetDefaultConsumes 

func (o *UUIDGenAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*UUIDGenAPI) SetDefaultProduces 

func (o *UUIDGenAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*UUIDGenAPI) SetSpec 

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

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

func (*UUIDGenAPI) UseRedoc 

func (o *UUIDGenAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*UUIDGenAPI) UseSwaggerUI 

func (o *UUIDGenAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*UUIDGenAPI) Validate 

func (o *UUIDGenAPI) Validate() error

Validate validates the registrations in the UUIDGenAPI

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.