adminoperations

Documentation

Index

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

Types

type MymoveAPI

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

	// AdminUsersCreateAdminUserHandler sets the operation handler for the create admin user operation
	AdminUsersCreateAdminUserHandler admin_users.CreateAdminUserHandler
	// OfficeUsersCreateOfficeUserHandler sets the operation handler for the create office user operation
	OfficeUsersCreateOfficeUserHandler office_users.CreateOfficeUserHandler
	// WebhookSubscriptionsCreateWebhookSubscriptionHandler sets the operation handler for the create webhook subscription operation
	WebhookSubscriptionsCreateWebhookSubscriptionHandler webhook_subscriptions.CreateWebhookSubscriptionHandler
	// AdminUsersGetAdminUserHandler sets the operation handler for the get admin user operation
	AdminUsersGetAdminUserHandler admin_users.GetAdminUserHandler
	// ElectronicOrderGetElectronicOrdersTotalsHandler sets the operation handler for the get electronic orders totals operation
	ElectronicOrderGetElectronicOrdersTotalsHandler electronic_order.GetElectronicOrdersTotalsHandler
	// MoveGetMoveHandler sets the operation handler for the get move operation
	MoveGetMoveHandler move.GetMoveHandler
	// OfficeUsersGetOfficeUserHandler sets the operation handler for the get office user operation
	OfficeUsersGetOfficeUserHandler office_users.GetOfficeUserHandler
	// TransportationServiceProviderPerformancesGetTSPPHandler sets the operation handler for the get t s p p operation
	TransportationServiceProviderPerformancesGetTSPPHandler transportation_service_provider_performances.GetTSPPHandler
	// UploadGetUploadHandler sets the operation handler for the get upload operation
	UploadGetUploadHandler upload.GetUploadHandler
	// UsersGetUserHandler sets the operation handler for the get user operation
	UsersGetUserHandler users.GetUserHandler
	// WebhookSubscriptionsGetWebhookSubscriptionHandler sets the operation handler for the get webhook subscription operation
	WebhookSubscriptionsGetWebhookSubscriptionHandler webhook_subscriptions.GetWebhookSubscriptionHandler
	// AdminUsersIndexAdminUsersHandler sets the operation handler for the index admin users operation
	AdminUsersIndexAdminUsersHandler admin_users.IndexAdminUsersHandler
	// ElectronicOrderIndexElectronicOrdersHandler sets the operation handler for the index electronic orders operation
	ElectronicOrderIndexElectronicOrdersHandler electronic_order.IndexElectronicOrdersHandler
	// MoveIndexMovesHandler sets the operation handler for the index moves operation
	MoveIndexMovesHandler move.IndexMovesHandler
	// NotificationIndexNotificationsHandler sets the operation handler for the index notifications operation
	NotificationIndexNotificationsHandler notification.IndexNotificationsHandler
	// OfficeUsersIndexOfficeUsersHandler sets the operation handler for the index office users operation
	OfficeUsersIndexOfficeUsersHandler office_users.IndexOfficeUsersHandler
	// OfficeIndexOfficesHandler sets the operation handler for the index offices operation
	OfficeIndexOfficesHandler office.IndexOfficesHandler
	// OrganizationIndexOrganizationsHandler sets the operation handler for the index organizations operation
	OrganizationIndexOrganizationsHandler organization.IndexOrganizationsHandler
	// TransportationServiceProviderPerformancesIndexTSPPsHandler sets the operation handler for the index t s p ps operation
	TransportationServiceProviderPerformancesIndexTSPPsHandler transportation_service_provider_performances.IndexTSPPsHandler
	// UsersIndexUsersHandler sets the operation handler for the index users operation
	UsersIndexUsersHandler users.IndexUsersHandler
	// WebhookSubscriptionsIndexWebhookSubscriptionsHandler sets the operation handler for the index webhook subscriptions operation
	WebhookSubscriptionsIndexWebhookSubscriptionsHandler webhook_subscriptions.IndexWebhookSubscriptionsHandler
	// AdminUsersUpdateAdminUserHandler sets the operation handler for the update admin user operation
	AdminUsersUpdateAdminUserHandler admin_users.UpdateAdminUserHandler
	// MoveUpdateMoveHandler sets the operation handler for the update move operation
	MoveUpdateMoveHandler move.UpdateMoveHandler
	// OfficeUsersUpdateOfficeUserHandler sets the operation handler for the update office user operation
	OfficeUsersUpdateOfficeUserHandler office_users.UpdateOfficeUserHandler
	// UsersUpdateUserHandler sets the operation handler for the update user operation
	UsersUpdateUserHandler users.UpdateUserHandler
	// WebhookSubscriptionsUpdateWebhookSubscriptionHandler sets the operation handler for the update webhook subscription operation
	WebhookSubscriptionsUpdateWebhookSubscriptionHandler webhook_subscriptions.UpdateWebhookSubscriptionHandler

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

MymoveAPI The Admin API is a RESTful API that enables the Admin application for MilMove.

All endpoints are located under `/admin/v1`.

func NewMymoveAPI

func NewMymoveAPI(spec *loads.Document) *MymoveAPI

NewMymoveAPI creates a new Mymove instance

func (*MymoveAPI) AddMiddlewareFor

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

AddMiddlewareFor adds a http middleware to existing handler

func (*MymoveAPI) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*MymoveAPI) Authorizer

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

Authorizer returns the registered authorizer

func (*MymoveAPI) ConsumersFor

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

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

func (*MymoveAPI) Context

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

Context returns the middleware context for the mymove API

func (*MymoveAPI) DefaultConsumes

func (o *MymoveAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*MymoveAPI) DefaultProduces

func (o *MymoveAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*MymoveAPI) Formats

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

Formats returns the registered string formats

func (*MymoveAPI) HandlerFor

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

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

func (*MymoveAPI) Init

func (o *MymoveAPI) Init()

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

func (*MymoveAPI) ProducersFor

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

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

func (*MymoveAPI) RegisterConsumer

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

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

func (*MymoveAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*MymoveAPI) RegisterProducer

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

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

func (*MymoveAPI) Serve

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

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

ServeErrorFor gets a error handler for a given operation id

func (*MymoveAPI) SetDefaultConsumes

func (o *MymoveAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*MymoveAPI) SetDefaultProduces

func (o *MymoveAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*MymoveAPI) SetSpec

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

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

func (*MymoveAPI) UseRedoc

func (o *MymoveAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*MymoveAPI) UseSwaggerUI

func (o *MymoveAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*MymoveAPI) Validate

func (o *MymoveAPI) Validate() error

Validate validates the registrations in the MymoveAPI