Documentation
¶
Index ¶
- type 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
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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
// MultipartformConsumer registers a consumer for the following mime types:
// - multipart/form-data
MultipartformConsumer runtime.Consumer
// BinProducer registers a producer for the following mime types:
// - application/pdf
BinProducer runtime.Producer
// JSONProducer registers a producer for the following mime types:
// - application/json
JSONProducer runtime.Producer
// OfficeApproveMoveHandler sets the operation handler for the approve move operation
OfficeApproveMoveHandler office.ApproveMoveHandler
// OfficeApproveReimbursementHandler sets the operation handler for the approve reimbursement operation
OfficeApproveReimbursementHandler office.ApproveReimbursementHandler
// FeatureFlagsBooleanFeatureFlagForUserHandler sets the operation handler for the boolean feature flag for user operation
FeatureFlagsBooleanFeatureFlagForUserHandler feature_flags.BooleanFeatureFlagForUserHandler
// OfficeCancelMoveHandler sets the operation handler for the cancel move operation
OfficeCancelMoveHandler office.CancelMoveHandler
// DocumentsCreateDocumentHandler sets the operation handler for the create document operation
DocumentsCreateDocumentHandler documents.CreateDocumentHandler
// MoveDocsCreateGenericMoveDocumentHandler sets the operation handler for the create generic move document operation
MoveDocsCreateGenericMoveDocumentHandler move_docs.CreateGenericMoveDocumentHandler
// MtoShipmentCreateMTOShipmentHandler sets the operation handler for the create m t o shipment operation
MtoShipmentCreateMTOShipmentHandler mto_shipment.CreateMTOShipmentHandler
// PpmCreateMovingExpenseHandler sets the operation handler for the create moving expense operation
PpmCreateMovingExpenseHandler ppm.CreateMovingExpenseHandler
// OrdersCreateOrdersHandler sets the operation handler for the create orders operation
OrdersCreateOrdersHandler orders.CreateOrdersHandler
// PpmCreatePPMUploadHandler sets the operation handler for the create p p m upload operation
PpmCreatePPMUploadHandler ppm.CreatePPMUploadHandler
// PpmCreateProGearWeightTicketHandler sets the operation handler for the create pro gear weight ticket operation
PpmCreateProGearWeightTicketHandler ppm.CreateProGearWeightTicketHandler
// ServiceMembersCreateServiceMemberHandler sets the operation handler for the create service member operation
ServiceMembersCreateServiceMemberHandler service_members.CreateServiceMemberHandler
// BackupContactsCreateServiceMemberBackupContactHandler sets the operation handler for the create service member backup contact operation
BackupContactsCreateServiceMemberBackupContactHandler backup_contacts.CreateServiceMemberBackupContactHandler
// CertificationCreateSignedCertificationHandler sets the operation handler for the create signed certification operation
CertificationCreateSignedCertificationHandler certification.CreateSignedCertificationHandler
// UploadsCreateUploadHandler sets the operation handler for the create upload operation
UploadsCreateUploadHandler uploads.CreateUploadHandler
// PpmCreateWeightTicketHandler sets the operation handler for the create weight ticket operation
PpmCreateWeightTicketHandler ppm.CreateWeightTicketHandler
// MoveDocsCreateWeightTicketDocumentHandler sets the operation handler for the create weight ticket document operation
MoveDocsCreateWeightTicketDocumentHandler move_docs.CreateWeightTicketDocumentHandler
// MoveDocsDeleteMoveDocumentHandler sets the operation handler for the delete move document operation
MoveDocsDeleteMoveDocumentHandler move_docs.DeleteMoveDocumentHandler
// PpmDeleteMovingExpenseHandler sets the operation handler for the delete moving expense operation
PpmDeleteMovingExpenseHandler ppm.DeleteMovingExpenseHandler
// PpmDeleteProGearWeightTicketHandler sets the operation handler for the delete pro gear weight ticket operation
PpmDeleteProGearWeightTicketHandler ppm.DeleteProGearWeightTicketHandler
// MtoShipmentDeleteShipmentHandler sets the operation handler for the delete shipment operation
MtoShipmentDeleteShipmentHandler mto_shipment.DeleteShipmentHandler
// UploadsDeleteUploadHandler sets the operation handler for the delete upload operation
UploadsDeleteUploadHandler uploads.DeleteUploadHandler
// UploadsDeleteUploadsHandler sets the operation handler for the delete uploads operation
UploadsDeleteUploadsHandler uploads.DeleteUploadsHandler
// PpmDeleteWeightTicketHandler sets the operation handler for the delete weight ticket operation
PpmDeleteWeightTicketHandler ppm.DeleteWeightTicketHandler
// MovesGetAllMovesHandler sets the operation handler for the get all moves operation
MovesGetAllMovesHandler moves.GetAllMovesHandler
// TransportationOfficesGetTransportationOfficesHandler sets the operation handler for the get transportation offices operation
TransportationOfficesGetTransportationOfficesHandler transportation_offices.GetTransportationOfficesHandler
// EntitlementsIndexEntitlementsHandler sets the operation handler for the index entitlements operation
EntitlementsIndexEntitlementsHandler entitlements.IndexEntitlementsHandler
// MoveDocsIndexMoveDocumentsHandler sets the operation handler for the index move documents operation
MoveDocsIndexMoveDocumentsHandler move_docs.IndexMoveDocumentsHandler
// BackupContactsIndexServiceMemberBackupContactsHandler sets the operation handler for the index service member backup contacts operation
BackupContactsIndexServiceMemberBackupContactsHandler backup_contacts.IndexServiceMemberBackupContactsHandler
// CertificationIndexSignedCertificationHandler sets the operation handler for the index signed certification operation
CertificationIndexSignedCertificationHandler certification.IndexSignedCertificationHandler
// CalendarIsDateWeekendHolidayHandler sets the operation handler for the is date weekend holiday operation
CalendarIsDateWeekendHolidayHandler calendar.IsDateWeekendHolidayHandler
// UsersIsLoggedInUserHandler sets the operation handler for the is logged in user operation
UsersIsLoggedInUserHandler users.IsLoggedInUserHandler
// MtoShipmentListMTOShipmentsHandler sets the operation handler for the list m t o shipments operation
MtoShipmentListMTOShipmentsHandler mto_shipment.ListMTOShipmentsHandler
// MovesPatchMoveHandler sets the operation handler for the patch move operation
MovesPatchMoveHandler moves.PatchMoveHandler
// ServiceMembersPatchServiceMemberHandler sets the operation handler for the patch service member operation
ServiceMembersPatchServiceMemberHandler service_members.PatchServiceMemberHandler
// PpmResubmitPPMShipmentDocumentationHandler sets the operation handler for the resubmit p p m shipment documentation operation
PpmResubmitPPMShipmentDocumentationHandler ppm.ResubmitPPMShipmentDocumentationHandler
// DutyLocationsSearchDutyLocationsHandler sets the operation handler for the search duty locations operation
DutyLocationsSearchDutyLocationsHandler duty_locations.SearchDutyLocationsHandler
// PpmShowAOAPacketHandler sets the operation handler for the show a o a packet operation
PpmShowAOAPacketHandler ppm.ShowAOAPacketHandler
// AddressesShowAddressHandler sets the operation handler for the show address operation
AddressesShowAddressHandler addresses.ShowAddressHandler
// CalendarShowAvailableMoveDatesHandler sets the operation handler for the show available move dates operation
CalendarShowAvailableMoveDatesHandler calendar.ShowAvailableMoveDatesHandler
// TransportationOfficesShowCounselingOfficesHandler sets the operation handler for the show counseling offices operation
TransportationOfficesShowCounselingOfficesHandler transportation_offices.ShowCounselingOfficesHandler
// DocumentsShowDocumentHandler sets the operation handler for the show document operation
DocumentsShowDocumentHandler documents.ShowDocumentHandler
// TransportationOfficesShowDutyLocationTransportationOfficeHandler sets the operation handler for the show duty location transportation office operation
TransportationOfficesShowDutyLocationTransportationOfficeHandler transportation_offices.ShowDutyLocationTransportationOfficeHandler
// UsersShowLoggedInUserHandler sets the operation handler for the show logged in user operation
UsersShowLoggedInUserHandler users.ShowLoggedInUserHandler
// MovesShowMoveHandler sets the operation handler for the show move operation
MovesShowMoveHandler moves.ShowMoveHandler
// OfficeShowOfficeOrdersHandler sets the operation handler for the show office orders operation
OfficeShowOfficeOrdersHandler office.ShowOfficeOrdersHandler
// OktaProfileShowOktaInfoHandler sets the operation handler for the show okta info operation
OktaProfileShowOktaInfoHandler okta_profile.ShowOktaInfoHandler
// OrdersShowOrdersHandler sets the operation handler for the show orders operation
OrdersShowOrdersHandler orders.ShowOrdersHandler
// PpmShowPaymentPacketHandler sets the operation handler for the show payment packet operation
PpmShowPaymentPacketHandler ppm.ShowPaymentPacketHandler
// QueuesShowQueueHandler sets the operation handler for the show queue operation
QueuesShowQueueHandler queues.ShowQueueHandler
// ServiceMembersShowServiceMemberHandler sets the operation handler for the show service member operation
ServiceMembersShowServiceMemberHandler service_members.ShowServiceMemberHandler
// BackupContactsShowServiceMemberBackupContactHandler sets the operation handler for the show service member backup contact operation
BackupContactsShowServiceMemberBackupContactHandler backup_contacts.ShowServiceMemberBackupContactHandler
// ServiceMembersShowServiceMemberOrdersHandler sets the operation handler for the show service member orders operation
ServiceMembersShowServiceMemberOrdersHandler service_members.ShowServiceMemberOrdersHandler
// MovesSubmitAmendedOrdersHandler sets the operation handler for the submit amended orders operation
MovesSubmitAmendedOrdersHandler moves.SubmitAmendedOrdersHandler
// MovesSubmitMoveForApprovalHandler sets the operation handler for the submit move for approval operation
MovesSubmitMoveForApprovalHandler moves.SubmitMoveForApprovalHandler
// PpmSubmitPPMShipmentDocumentationHandler sets the operation handler for the submit p p m shipment documentation operation
PpmSubmitPPMShipmentDocumentationHandler ppm.SubmitPPMShipmentDocumentationHandler
// MtoShipmentUpdateMTOShipmentHandler sets the operation handler for the update m t o shipment operation
MtoShipmentUpdateMTOShipmentHandler mto_shipment.UpdateMTOShipmentHandler
// MoveDocsUpdateMoveDocumentHandler sets the operation handler for the update move document operation
MoveDocsUpdateMoveDocumentHandler move_docs.UpdateMoveDocumentHandler
// PpmUpdateMovingExpenseHandler sets the operation handler for the update moving expense operation
PpmUpdateMovingExpenseHandler ppm.UpdateMovingExpenseHandler
// OktaProfileUpdateOktaInfoHandler sets the operation handler for the update okta info operation
OktaProfileUpdateOktaInfoHandler okta_profile.UpdateOktaInfoHandler
// OrdersUpdateOrdersHandler sets the operation handler for the update orders operation
OrdersUpdateOrdersHandler orders.UpdateOrdersHandler
// PpmUpdateProGearWeightTicketHandler sets the operation handler for the update pro gear weight ticket operation
PpmUpdateProGearWeightTicketHandler ppm.UpdateProGearWeightTicketHandler
// BackupContactsUpdateServiceMemberBackupContactHandler sets the operation handler for the update service member backup contact operation
BackupContactsUpdateServiceMemberBackupContactHandler backup_contacts.UpdateServiceMemberBackupContactHandler
// PpmUpdateWeightTicketHandler sets the operation handler for the update weight ticket operation
PpmUpdateWeightTicketHandler ppm.UpdateWeightTicketHandler
// MovesUploadAdditionalDocumentsHandler sets the operation handler for the upload additional documents operation
MovesUploadAdditionalDocumentsHandler moves.UploadAdditionalDocumentsHandler
// OrdersUploadAmendedOrdersHandler sets the operation handler for the upload amended orders operation
OrdersUploadAmendedOrdersHandler orders.UploadAmendedOrdersHandler
// ApplicationParametersValidateHandler sets the operation handler for the validate operation
ApplicationParametersValidateHandler application_parameters.ValidateHandler
// PostalCodesValidatePostalCodeWithRateDataHandler sets the operation handler for the validate postal code with rate data operation
PostalCodesValidatePostalCodeWithRateDataHandler postal_codes.ValidatePostalCodeWithRateDataHandler
// FeatureFlagsVariantFeatureFlagForUserHandler sets the operation handler for the variant feature flag for user operation
FeatureFlagsVariantFeatureFlagForUserHandler feature_flags.VariantFeatureFlagForUserHandler
// 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 Internal API is a RESTful API that enables the Customer application for MilMove.
All endpoints are located under `/internal`.
func NewMymoveAPI ¶
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 ¶
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 ¶
DefaultConsumes returns the default consumes media type
func (*MymoveAPI) DefaultProduces ¶
DefaultProduces returns the default produces media type
func (*MymoveAPI) HandlerFor ¶
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 ¶
ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.
func (*MymoveAPI) RegisterConsumer ¶
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*MymoveAPI) RegisterFormat ¶
RegisterFormat registers a custom format validator
func (*MymoveAPI) RegisterProducer ¶
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 ¶
SetDefaultConsumes returns the default consumes media type
func (*MymoveAPI) SetDefaultProduces ¶
SetDefaultProduces sets the default produces media type
func (*MymoveAPI) UseSwaggerUI ¶
func (o *MymoveAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs