operations

Documentation

Index

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

Types

type ImageapiAPI

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

	// AttachmentsDeleteAttachHandler sets the operation handler for the delete attach operation
	AttachmentsDeleteAttachHandler attachments.DeleteAttachHandler
	// MountsDeleteMountHandler sets the operation handler for the delete mount operation
	MountsDeleteMountHandler mounts.DeleteMountHandler
	// AttachmentsAttachHandler sets the operation handler for the attach operation
	AttachmentsAttachHandler attachments.AttachHandler
	// ContainersCreateContainerHandler sets the operation handler for the create container operation
	ContainersCreateContainerHandler containers.CreateContainerHandler
	// ContainersDeleteContainerHandler sets the operation handler for the delete container operation
	ContainersDeleteContainerHandler containers.DeleteContainerHandler
	// AttachmentsListAttachmentsHandler sets the operation handler for the list attachments operation
	AttachmentsListAttachmentsHandler attachments.ListAttachmentsHandler
	// ContainersListContainersHandler sets the operation handler for the list containers operation
	ContainersListContainersHandler containers.ListContainersHandler
	// MountsListMountsHandler sets the operation handler for the list mounts operation
	MountsListMountsHandler mounts.ListMountsHandler
	// MountsMountHandler sets the operation handler for the mount operation
	MountsMountHandler mounts.MountHandler
	// ContainersSetContainerStateHandler sets the operation handler for the set container state operation
	ContainersSetContainerStateHandler containers.SetContainerStateHandler

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

ImageapiAPI This API specification describes a service for attaching, mounting and preparing container images and manipulating those containers.

In general, higher level objects can either reference lower level objects (e.g. a mount referencing an attachment point) by a reference ID, or, they can contain the full specification of those lower objects.

If an object references another by ID, deletion of that object does not effect the underlying object.

If an object defines a lower level object, that lower level object will automatically be deleted on deletion of the higher level object.

For instance, if a container contains all of the defintions for all mount points and attachments, deletion of the container will automatically unmount and detach those lower objects.

func NewImageapiAPI

func NewImageapiAPI(spec *loads.Document) *ImageapiAPI

NewImageapiAPI creates a new Imageapi instance

func (*ImageapiAPI) AddMiddlewareFor

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

AddMiddlewareFor adds a http middleware to existing handler

func (*ImageapiAPI) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*ImageapiAPI) Authorizer

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

Authorizer returns the registered authorizer

func (*ImageapiAPI) ConsumersFor

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

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

func (*ImageapiAPI) Context

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

Context returns the middleware context for the imageapi API

func (*ImageapiAPI) DefaultConsumes

func (o *ImageapiAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*ImageapiAPI) DefaultProduces

func (o *ImageapiAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*ImageapiAPI) Formats

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

Formats returns the registered string formats

func (*ImageapiAPI) HandlerFor

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

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

func (*ImageapiAPI) Init

func (o *ImageapiAPI) Init()

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

func (*ImageapiAPI) ProducersFor

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

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

func (*ImageapiAPI) RegisterConsumer

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

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

func (*ImageapiAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*ImageapiAPI) RegisterProducer

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

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

func (*ImageapiAPI) Serve

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

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

ServeErrorFor gets a error handler for a given operation id

func (*ImageapiAPI) SetDefaultConsumes

func (o *ImageapiAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*ImageapiAPI) SetDefaultProduces

func (o *ImageapiAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*ImageapiAPI) SetSpec

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

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

func (*ImageapiAPI) UseRedoc

func (o *ImageapiAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*ImageapiAPI) UseSwaggerUI

func (o *ImageapiAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*ImageapiAPI) Validate

func (o *ImageapiAPI) Validate() error

Validate validates the registrations in the ImageapiAPI