operations

Documentation

Index

• type StorageAPI
  • func NewStorageAPI(spec *loads.Document) *StorageAPI
  • func (o *StorageAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
  • func (o *StorageAPI) Authorizer() runtime.Authorizer
  • func (o *StorageAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
  • func (o *StorageAPI) Context() *middleware.Context
  • func (o *StorageAPI) DefaultConsumes() string
  • func (o *StorageAPI) DefaultProduces() string
  • func (o *StorageAPI) Formats() strfmt.Registry
  • func (o *StorageAPI) HandlerFor(method, path string) (http.Handler, bool)
  • func (o *StorageAPI) Init()
  • func (o *StorageAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
  • func (o *StorageAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
  • func (o *StorageAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
  • func (o *StorageAPI) RegisterProducer(mediaType string, producer runtime.Producer)
  • func (o *StorageAPI) Serve(builder middleware.Builder) http.Handler
  • func (o *StorageAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
  • func (o *StorageAPI) SetDefaultConsumes(mediaType string)
  • func (o *StorageAPI) SetDefaultProduces(mediaType string)
  • func (o *StorageAPI) SetSpec(spec *loads.Document)
  • func (o *StorageAPI) Validate() error

Types

type StorageAPI

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

	// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
	// It has a default implemention 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 implemention 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 implemention 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 a "application/json" mime type
	JSONConsumer runtime.Consumer

	// JSONProducer registers a producer for a "application/json" mime type
	JSONProducer runtime.Producer

	// AirlinesGetAirlinesHandler sets the operation handler for the get airlines operation
	AirlinesGetAirlinesHandler airlines.GetAirlinesHandler
	// AirportsGetAirportsHandler sets the operation handler for the get airports operation
	AirportsGetAirportsHandler airports.GetAirportsHandler
	// LivenessGetLiveHandler sets the operation handler for the get live operation
	LivenessGetLiveHandler liveness.GetLiveHandler
	// ReadinessGetReadyHandler sets the operation handler for the get ready operation
	ReadinessGetReadyHandler readiness.GetReadyHandler
	// SchedulesGetSchedulesHandler sets the operation handler for the get schedules operation
	SchedulesGetSchedulesHandler schedules.GetSchedulesHandler
	// VersionGetVersionHandler sets the operation handler for the get version operation
	VersionGetVersionHandler version.GetVersionHandler
	// AirlinesAddAirlineHandler sets the operation handler for the add airline operation
	AirlinesAddAirlineHandler airlines.AddAirlineHandler
	// AirportsAddAirportHandler sets the operation handler for the add airport operation
	AirportsAddAirportHandler airports.AddAirportHandler
	// SchedulesAddScheduleHandler sets the operation handler for the add schedule operation
	SchedulesAddScheduleHandler schedules.AddScheduleHandler
	// SchedulesDeleteScheduleHandler sets the operation handler for the delete schedule operation
	SchedulesDeleteScheduleHandler schedules.DeleteScheduleHandler
	// SchedulesGetScheduleHandler sets the operation handler for the get schedule operation
	SchedulesGetScheduleHandler schedules.GetScheduleHandler
	// SchedulesUpdateScheduleHandler sets the operation handler for the update schedule operation
	SchedulesUpdateScheduleHandler schedules.UpdateScheduleHandler

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

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

StorageAPI needs to add a description

func NewStorageAPI

func NewStorageAPI(spec *loads.Document) *StorageAPI

NewStorageAPI creates a new Storage instance

func (*StorageAPI) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*StorageAPI) Authorizer

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

Authorizer returns the registered authorizer

func (*StorageAPI) ConsumersFor

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

ConsumersFor gets the consumers for the specified media types

func (*StorageAPI) Context

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

Context returns the middleware context for the storage API

func (*StorageAPI) DefaultConsumes

func (o *StorageAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*StorageAPI) DefaultProduces

func (o *StorageAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*StorageAPI) Formats

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

Formats returns the registered string formats

func (*StorageAPI) HandlerFor

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

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

func (*StorageAPI) Init

func (o *StorageAPI) Init()

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

func (*StorageAPI) ProducersFor

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

ProducersFor gets the producers for the specified media types

func (*StorageAPI) RegisterConsumer

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

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

func (*StorageAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*StorageAPI) RegisterProducer

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

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

func (*StorageAPI) Serve

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

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

ServeErrorFor gets a error handler for a given operation id

func (*StorageAPI) SetDefaultConsumes

func (o *StorageAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*StorageAPI) SetDefaultProduces

func (o *StorageAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*StorageAPI) SetSpec

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

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

func (*StorageAPI) Validate

func (o *StorageAPI) Validate() error

Validate validates the registrations in the StorageAPI