operations

package
v0.2.2 Latest Latest
Warning

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

Go to latest
Published: Feb 23, 2022 License: AGPL-3.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BookingAPI

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

	// BearerAuth registers a function that takes a token and returns a principal
	// it performs authentication based on an api key Authorization provided in the header
	BearerAuth func(string) (interface{}, error)

	// APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal
	APIAuthorizer runtime.Authorizer

	// PoolsAddActivityByPoolIDHandler sets the operation handler for the add activity by pool ID operation
	PoolsAddActivityByPoolIDHandler pools.AddActivityByPoolIDHandler
	// GroupsAddNewGroupHandler sets the operation handler for the add new group operation
	GroupsAddNewGroupHandler groups.AddNewGroupHandler
	// PoolsAddNewPoolHandler sets the operation handler for the add new pool operation
	PoolsAddNewPoolHandler pools.AddNewPoolHandler
	// GroupsAddPoolsByGroupIDHandler sets the operation handler for the add pools by group ID operation
	GroupsAddPoolsByGroupIDHandler groups.AddPoolsByGroupIDHandler
	// PoolsDeleteActivityByIDHandler sets the operation handler for the delete activity by ID operation
	PoolsDeleteActivityByIDHandler pools.DeleteActivityByIDHandler
	// GroupsDeleteGroupHandler sets the operation handler for the delete group operation
	GroupsDeleteGroupHandler groups.DeleteGroupHandler
	// PoolsDeletePoolHandler sets the operation handler for the delete pool operation
	PoolsDeletePoolHandler pools.DeletePoolHandler
	// AdminDeletePoolStoreHandler sets the operation handler for the delete pool store operation
	AdminDeletePoolStoreHandler admin.DeletePoolStoreHandler
	// GroupsDeletePoolsByGroupIDHandler sets the operation handler for the delete pools by group ID operation
	GroupsDeletePoolsByGroupIDHandler groups.DeletePoolsByGroupIDHandler
	// AdminExportPoolStoreHandler sets the operation handler for the export pool store operation
	AdminExportPoolStoreHandler admin.ExportPoolStoreHandler
	// PoolsGetActivityByIDHandler sets the operation handler for the get activity by ID operation
	PoolsGetActivityByIDHandler pools.GetActivityByIDHandler
	// PoolsGetAllPoolsHandler sets the operation handler for the get all pools operation
	PoolsGetAllPoolsHandler pools.GetAllPoolsHandler
	// LoginGetCurrentBookingsHandler sets the operation handler for the get current bookings operation
	LoginGetCurrentBookingsHandler login.GetCurrentBookingsHandler
	// GroupsGetGroupDescriptionByIDHandler sets the operation handler for the get group description by ID operation
	GroupsGetGroupDescriptionByIDHandler groups.GetGroupDescriptionByIDHandler
	// GroupsGetGroupIDByNameHandler sets the operation handler for the get group ID by name operation
	GroupsGetGroupIDByNameHandler groups.GetGroupIDByNameHandler
	// PoolsGetPoolDescriptionByIDHandler sets the operation handler for the get pool description by ID operation
	PoolsGetPoolDescriptionByIDHandler pools.GetPoolDescriptionByIDHandler
	// PoolsGetPoolStatusByIDHandler sets the operation handler for the get pool status by ID operation
	PoolsGetPoolStatusByIDHandler pools.GetPoolStatusByIDHandler
	// GroupsGetPoolsByGroupIDHandler sets the operation handler for the get pools by group ID operation
	GroupsGetPoolsByGroupIDHandler groups.GetPoolsByGroupIDHandler
	// AdminGetStoreStatusHandler sets the operation handler for the get store status operation
	AdminGetStoreStatusHandler admin.GetStoreStatusHandler
	// AdminImportPoolStoreHandler sets the operation handler for the import pool store operation
	AdminImportPoolStoreHandler admin.ImportPoolStoreHandler
	// LoginLoginHandler sets the operation handler for the login operation
	LoginLoginHandler login.LoginHandler
	// GroupsReplacePoolsByGroupIDHandler sets the operation handler for the replace pools by group ID operation
	GroupsReplacePoolsByGroupIDHandler groups.ReplacePoolsByGroupIDHandler
	// PoolsRequestSessionByPoolIDHandler sets the operation handler for the request session by pool ID operation
	PoolsRequestSessionByPoolIDHandler pools.RequestSessionByPoolIDHandler
	// AdminSetLockHandler sets the operation handler for the set lock operation
	AdminSetLockHandler admin.SetLockHandler
	// PoolsUpdateActivityByIDHandler sets the operation handler for the update activity by ID operation
	PoolsUpdateActivityByIDHandler pools.UpdateActivityByIDHandler

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

BookingAPI User API for booking experiments

func NewBookingAPI

func NewBookingAPI(spec *loads.Document) *BookingAPI

NewBookingAPI creates a new Booking instance

func (*BookingAPI) AddMiddlewareFor

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

AddMiddlewareFor adds a http middleware to existing handler

func (*BookingAPI) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*BookingAPI) Authorizer

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

Authorizer returns the registered authorizer

func (*BookingAPI) ConsumersFor

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

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

func (*BookingAPI) Context

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

Context returns the middleware context for the booking API

func (*BookingAPI) DefaultConsumes

func (o *BookingAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*BookingAPI) DefaultProduces

func (o *BookingAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*BookingAPI) Formats

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

Formats returns the registered string formats

func (*BookingAPI) HandlerFor

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

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

func (*BookingAPI) Init

func (o *BookingAPI) Init()

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

func (*BookingAPI) ProducersFor

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

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

func (*BookingAPI) RegisterConsumer

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

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

func (*BookingAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*BookingAPI) RegisterProducer

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

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

func (*BookingAPI) Serve

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

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

ServeErrorFor gets a error handler for a given operation id

func (*BookingAPI) SetDefaultConsumes

func (o *BookingAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*BookingAPI) SetDefaultProduces

func (o *BookingAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*BookingAPI) SetSpec

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

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

func (*BookingAPI) UseRedoc

func (o *BookingAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*BookingAPI) UseSwaggerUI

func (o *BookingAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*BookingAPI) Validate

func (o *BookingAPI) Validate() error

Validate validates the registrations in the BookingAPI

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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