operations

Documentation

Index

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

Types

type GoliacAPI

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

	// AppGetCollaboratorHandler sets the operation handler for the get collaborator operation
	AppGetCollaboratorHandler app.GetCollaboratorHandler
	// AppGetCollaboratorsHandler sets the operation handler for the get collaborators operation
	AppGetCollaboratorsHandler app.GetCollaboratorsHandler
	// HealthGetLivenessHandler sets the operation handler for the get liveness operation
	HealthGetLivenessHandler health.GetLivenessHandler
	// HealthGetReadinessHandler sets the operation handler for the get readiness operation
	HealthGetReadinessHandler health.GetReadinessHandler
	// AppGetRepositoriesHandler sets the operation handler for the get repositories operation
	AppGetRepositoriesHandler app.GetRepositoriesHandler
	// AppGetRepositoryHandler sets the operation handler for the get repository operation
	AppGetRepositoryHandler app.GetRepositoryHandler
	// AppGetStatiticsHandler sets the operation handler for the get statitics operation
	AppGetStatiticsHandler app.GetStatiticsHandler
	// AppGetStatusHandler sets the operation handler for the get status operation
	AppGetStatusHandler app.GetStatusHandler
	// AppGetTeamHandler sets the operation handler for the get team operation
	AppGetTeamHandler app.GetTeamHandler
	// AppGetTeamsHandler sets the operation handler for the get teams operation
	AppGetTeamsHandler app.GetTeamsHandler
	// AppGetUnmanagedHandler sets the operation handler for the get unmanaged operation
	AppGetUnmanagedHandler app.GetUnmanagedHandler
	// AppGetUserHandler sets the operation handler for the get user operation
	AppGetUserHandler app.GetUserHandler
	// AppGetUsersHandler sets the operation handler for the get users operation
	AppGetUsersHandler app.GetUsersHandler
	// AppPostFlushCacheHandler sets the operation handler for the post flush cache operation
	AppPostFlushCacheHandler app.PostFlushCacheHandler
	// AppPostResyncHandler sets the operation handler for the post resync operation
	AppPostResyncHandler app.PostResyncHandler

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

GoliacAPI goliac is a golang REST application skeleton The base path for all the APIs is "/api/v1".

func NewGoliacAPI

func NewGoliacAPI(spec *loads.Document) *GoliacAPI

NewGoliacAPI creates a new Goliac instance

func (*GoliacAPI) AddMiddlewareFor

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

AddMiddlewareFor adds a http middleware to existing handler

func (*GoliacAPI) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*GoliacAPI) Authorizer

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

Authorizer returns the registered authorizer

func (*GoliacAPI) ConsumersFor

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

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

func (*GoliacAPI) Context

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

Context returns the middleware context for the goliac API

func (*GoliacAPI) DefaultConsumes

func (o *GoliacAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*GoliacAPI) DefaultProduces

func (o *GoliacAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*GoliacAPI) Formats

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

Formats returns the registered string formats

func (*GoliacAPI) HandlerFor

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

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

func (*GoliacAPI) Init

func (o *GoliacAPI) Init()

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

func (*GoliacAPI) ProducersFor

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

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

func (*GoliacAPI) RegisterConsumer

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

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

func (*GoliacAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*GoliacAPI) RegisterProducer

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

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

func (*GoliacAPI) Serve

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

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

ServeErrorFor gets a error handler for a given operation id

func (*GoliacAPI) SetDefaultConsumes

func (o *GoliacAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*GoliacAPI) SetDefaultProduces

func (o *GoliacAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*GoliacAPI) SetSpec

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

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

func (*GoliacAPI) UseRedoc

func (o *GoliacAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*GoliacAPI) UseSwaggerUI

func (o *GoliacAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*GoliacAPI) Validate

func (o *GoliacAPI) Validate() error

Validate validates the registrations in the GoliacAPI