operations

package
v0.0.2 Latest Latest
Warning

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

Go to latest
Published: May 9, 2018 License: Apache-2.0 Imports: 13 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type OptikonAPI

type OptikonAPI 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
	// MultipartformConsumer registers a consumer for a "multipart/form-data" mime type
	MultipartformConsumer runtime.Consumer

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

	// ClustersAddClusterHandler sets the operation handler for the add cluster operation
	ClustersAddClusterHandler clusters.AddClusterHandler
	// ReleasesAddReleasesHandler sets the operation handler for the add releases operation
	ReleasesAddReleasesHandler releases.AddReleasesHandler
	// ClustersDeleteClusterHandler sets the operation handler for the delete cluster operation
	ClustersDeleteClusterHandler clusters.DeleteClusterHandler
	// ReleasesDeleteReleaseHandler sets the operation handler for the delete release operation
	ReleasesDeleteReleaseHandler releases.DeleteReleaseHandler
	// ClustersGetClusterByIDHandler sets the operation handler for the get cluster by Id operation
	ClustersGetClusterByIDHandler clusters.GetClusterByIDHandler
	// ClustersGetClustersHandler sets the operation handler for the get clusters operation
	ClustersGetClustersHandler clusters.GetClustersHandler
	// ReleasesGetReleaseByIDHandler sets the operation handler for the get release by Id operation
	ReleasesGetReleaseByIDHandler releases.GetReleaseByIDHandler
	// ReleasesGetReleasesHandler sets the operation handler for the get releases operation
	ReleasesGetReleasesHandler releases.GetReleasesHandler
	// ClustersUpdateClusterHandler sets the operation handler for the update cluster operation
	ClustersUpdateClusterHandler clusters.UpdateClusterHandler
	// ReleasesUpdateReleaseHandler sets the operation handler for the update release operation
	ReleasesUpdateReleaseHandler releases.UpdateReleaseHandler

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

OptikonAPI Optikon is an edge computing API for Kubernetes. It exposes Helm and the cluster registry for a comprehensive UI

func NewOptikonAPI

func NewOptikonAPI(spec *loads.Document) *OptikonAPI

NewOptikonAPI creates a new Optikon instance

func (*OptikonAPI) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*OptikonAPI) Authorizer

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

Authorizer returns the registered authorizer

func (*OptikonAPI) ConsumersFor

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

ConsumersFor gets the consumers for the specified media types

func (*OptikonAPI) Context

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

Context returns the middleware context for the optikon API

func (*OptikonAPI) DefaultConsumes

func (o *OptikonAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*OptikonAPI) DefaultProduces

func (o *OptikonAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*OptikonAPI) Formats

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

Formats returns the registered string formats

func (*OptikonAPI) HandlerFor

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

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

func (*OptikonAPI) Init

func (o *OptikonAPI) Init()

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

func (*OptikonAPI) ProducersFor

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

ProducersFor gets the producers for the specified media types

func (*OptikonAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*OptikonAPI) Serve

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

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

ServeErrorFor gets a error handler for a given operation id

func (*OptikonAPI) SetDefaultConsumes

func (o *OptikonAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*OptikonAPI) SetDefaultProduces

func (o *OptikonAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*OptikonAPI) SetSpec

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

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

func (*OptikonAPI) Validate

func (o *OptikonAPI) Validate() error

Validate validates the registrations in the OptikonAPI

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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