operations

package
v0.0.0-...-bebabf7 Latest Latest
Warning

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

Go to latest
Published: Jan 1, 2024 License: MIT Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ProviderServiceAPI

type ProviderServiceAPI 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
	// UrlformConsumer registers a consumer for the following mime types:
	//   - application/x-www-form-urlencoded
	UrlformConsumer runtime.Consumer

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

	// PublicGetAuthorizeHandler sets the operation handler for the get authorize operation
	PublicGetAuthorizeHandler public.GetAuthorizeHandler
	// PublicGetCredentialsHandler sets the operation handler for the get credentials operation
	PublicGetCredentialsHandler public.GetCredentialsHandler
	// PublicGetGoogleCallbackHandler sets the operation handler for the get google callback operation
	PublicGetGoogleCallbackHandler public.GetGoogleCallbackHandler
	// PublicGetGoogleLoginHandler sets the operation handler for the get google login operation
	PublicGetGoogleLoginHandler public.GetGoogleLoginHandler
	// InstrumentsGetMetricsHandler sets the operation handler for the get metrics operation
	InstrumentsGetMetricsHandler instruments.GetMetricsHandler
	// PublicGetPingHandler sets the operation handler for the get ping operation
	PublicGetPingHandler public.GetPingHandler
	// PublicGetTelegramCallbackHandler sets the operation handler for the get telegram callback operation
	PublicGetTelegramCallbackHandler public.GetTelegramCallbackHandler
	// PublicGetTelegramLoginHandler sets the operation handler for the get telegram login operation
	PublicGetTelegramLoginHandler public.GetTelegramLoginHandler
	// PublicGetValidateHandler sets the operation handler for the get validate operation
	PublicGetValidateHandler public.GetValidateHandler
	// PublicGetVkCallbackHandler sets the operation handler for the get vk callback operation
	PublicGetVkCallbackHandler public.GetVkCallbackHandler
	// PublicGetVkLoginHandler sets the operation handler for the get vk login operation
	PublicGetVkLoginHandler public.GetVkLoginHandler
	// PublicGetYandexCallbackHandler sets the operation handler for the get yandex callback operation
	PublicGetYandexCallbackHandler public.GetYandexCallbackHandler
	// PublicGetYandexLoginHandler sets the operation handler for the get yandex login operation
	PublicGetYandexLoginHandler public.GetYandexLoginHandler
	// PublicPostTokenHandler sets the operation handler for the post token operation
	PublicPostTokenHandler public.PostTokenHandler

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

ProviderServiceAPI the provider service API

func NewProviderServiceAPI

func NewProviderServiceAPI(spec *loads.Document) *ProviderServiceAPI

NewProviderServiceAPI creates a new ProviderService instance

func (*ProviderServiceAPI) AddMiddlewareFor

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

AddMiddlewareFor adds a http middleware to existing handler

func (*ProviderServiceAPI) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*ProviderServiceAPI) Authorizer

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

Authorizer returns the registered authorizer

func (*ProviderServiceAPI) ConsumersFor

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

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

func (*ProviderServiceAPI) Context

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

Context returns the middleware context for the provider service API

func (*ProviderServiceAPI) DefaultConsumes

func (o *ProviderServiceAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*ProviderServiceAPI) DefaultProduces

func (o *ProviderServiceAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*ProviderServiceAPI) Formats

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

Formats returns the registered string formats

func (*ProviderServiceAPI) HandlerFor

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

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

func (*ProviderServiceAPI) Init

func (o *ProviderServiceAPI) Init()

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

func (*ProviderServiceAPI) ProducersFor

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

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

func (*ProviderServiceAPI) RegisterConsumer

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

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

func (*ProviderServiceAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*ProviderServiceAPI) RegisterProducer

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

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

func (*ProviderServiceAPI) Serve

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

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

ServeErrorFor gets a error handler for a given operation id

func (*ProviderServiceAPI) SetDefaultConsumes

func (o *ProviderServiceAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*ProviderServiceAPI) SetDefaultProduces

func (o *ProviderServiceAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*ProviderServiceAPI) SetSpec

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

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

func (*ProviderServiceAPI) UseRedoc

func (o *ProviderServiceAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*ProviderServiceAPI) UseSwaggerUI

func (o *ProviderServiceAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*ProviderServiceAPI) Validate

func (o *ProviderServiceAPI) Validate() error

Validate validates the registrations in the ProviderServiceAPI

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL