Documentation
¶
Overview ¶
generated code - do not edit
generated code - do not edit
generated code - do not edit
generated code - do not edit
generated code - do not edit
generated code - do not edit
generated code - do not edit
generated code - do not edit
generated code - do not edit
Index ¶
- func Register(r *gin.Engine)
- type CivilianAirportID
- type CivilianAirportInput
- type Controller
- func (controller *Controller) AddBackRepo(backRepo *gongfly_orm.BackRepoStruct, stackPath string)
- func (controller *Controller) DeleteCivilianAirport(c *gin.Context)
- func (controller *Controller) DeleteLiner(c *gin.Context)
- func (controller *Controller) DeleteMessage(c *gin.Context)
- func (controller *Controller) DeleteOpsLine(c *gin.Context)
- func (controller *Controller) DeleteRadar(c *gin.Context)
- func (controller *Controller) DeleteSatellite(c *gin.Context)
- func (controller *Controller) DeleteScenario(c *gin.Context)
- func (controller *Controller) GetCivilianAirport(c *gin.Context)
- func (controller *Controller) GetCivilianAirports(c *gin.Context)
- func (controller *Controller) GetLastCommitFromBackNb(c *gin.Context)
- func (controller *Controller) GetLastPushFromFrontNb(c *gin.Context)
- func (controller *Controller) GetLiner(c *gin.Context)
- func (controller *Controller) GetLiners(c *gin.Context)
- func (controller *Controller) GetMessage(c *gin.Context)
- func (controller *Controller) GetMessages(c *gin.Context)
- func (controller *Controller) GetOpsLine(c *gin.Context)
- func (controller *Controller) GetOpsLines(c *gin.Context)
- func (controller *Controller) GetRadar(c *gin.Context)
- func (controller *Controller) GetRadars(c *gin.Context)
- func (controller *Controller) GetSatellite(c *gin.Context)
- func (controller *Controller) GetSatellites(c *gin.Context)
- func (controller *Controller) GetScenario(c *gin.Context)
- func (controller *Controller) GetScenarios(c *gin.Context)
- func (controller *Controller) PostCivilianAirport(c *gin.Context)
- func (controller *Controller) PostLiner(c *gin.Context)
- func (controller *Controller) PostMessage(c *gin.Context)
- func (controller *Controller) PostOpsLine(c *gin.Context)
- func (controller *Controller) PostRadar(c *gin.Context)
- func (controller *Controller) PostSatellite(c *gin.Context)
- func (controller *Controller) PostScenario(c *gin.Context)
- func (controller *Controller) UpdateCivilianAirport(c *gin.Context)
- func (controller *Controller) UpdateLiner(c *gin.Context)
- func (controller *Controller) UpdateMessage(c *gin.Context)
- func (controller *Controller) UpdateOpsLine(c *gin.Context)
- func (controller *Controller) UpdateRadar(c *gin.Context)
- func (controller *Controller) UpdateSatellite(c *gin.Context)
- func (controller *Controller) UpdateScenario(c *gin.Context)
- type GenericError
- type LinerID
- type LinerInput
- type MessageID
- type MessageInput
- type OpsLineID
- type OpsLineInput
- type RadarID
- type RadarInput
- type SatelliteID
- type SatelliteInput
- type ScenarioID
- type ScenarioInput
- type ValidationError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CivilianAirportID ¶
type CivilianAirportID struct { // The ID of the order // // in: path // required: true ID int64 }
An CivilianAirportID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getCivilianAirport updateCivilianAirport deleteCivilianAirport
type CivilianAirportInput ¶
type CivilianAirportInput struct { // The CivilianAirport to submit or modify // in: body CivilianAirport *orm.CivilianAirportAPI }
CivilianAirportInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postCivilianAirport updateCivilianAirport
type Controller ¶
type Controller struct { // Map_BackRepos is the map to the backRepo instance according to the stack instance path Map_BackRepos map[string]*gongfly_orm.BackRepoStruct // contains filtered or unexported fields }
A Controller is the handler of all API REST calls matching the stack model It forwards API requests to the stack instance identified by the GONG_StackPath parameters in the request the stack instance is the BackRepo instance
func GetController ¶
func GetController() *Controller
func (*Controller) AddBackRepo ¶
func (controller *Controller) AddBackRepo(backRepo *gongfly_orm.BackRepoStruct, stackPath string)
func (*Controller) DeleteCivilianAirport ¶
func (controller *Controller) DeleteCivilianAirport(c *gin.Context)
DeleteCivilianAirport
swagger:route DELETE /civilianairports/{ID} civilianairports deleteCivilianAirport
Delete a civilianairport ¶
default: genericError
200: civilianairportDBResponse
func (*Controller) DeleteLiner ¶
func (controller *Controller) DeleteLiner(c *gin.Context)
DeleteLiner
swagger:route DELETE /liners/{ID} liners deleteLiner
Delete a liner ¶
default: genericError
200: linerDBResponse
func (*Controller) DeleteMessage ¶
func (controller *Controller) DeleteMessage(c *gin.Context)
DeleteMessage
swagger:route DELETE /messages/{ID} messages deleteMessage
Delete a message ¶
default: genericError
200: messageDBResponse
func (*Controller) DeleteOpsLine ¶
func (controller *Controller) DeleteOpsLine(c *gin.Context)
DeleteOpsLine
swagger:route DELETE /opslines/{ID} opslines deleteOpsLine
Delete a opsline ¶
default: genericError
200: opslineDBResponse
func (*Controller) DeleteRadar ¶
func (controller *Controller) DeleteRadar(c *gin.Context)
DeleteRadar
swagger:route DELETE /radars/{ID} radars deleteRadar
Delete a radar ¶
default: genericError
200: radarDBResponse
func (*Controller) DeleteSatellite ¶
func (controller *Controller) DeleteSatellite(c *gin.Context)
DeleteSatellite
swagger:route DELETE /satellites/{ID} satellites deleteSatellite
Delete a satellite ¶
default: genericError
200: satelliteDBResponse
func (*Controller) DeleteScenario ¶
func (controller *Controller) DeleteScenario(c *gin.Context)
DeleteScenario
swagger:route DELETE /scenarios/{ID} scenarios deleteScenario
Delete a scenario ¶
default: genericError
200: scenarioDBResponse
func (*Controller) GetCivilianAirport ¶
func (controller *Controller) GetCivilianAirport(c *gin.Context)
GetCivilianAirport
swagger:route GET /civilianairports/{ID} civilianairports getCivilianAirport
Gets the details for a civilianairport.
Responses: default: genericError
200: civilianairportDBResponse
func (*Controller) GetCivilianAirports ¶
func (controller *Controller) GetCivilianAirports(c *gin.Context)
GetCivilianAirports
swagger:route GET /civilianairports civilianairports getCivilianAirports
Get all civilianairports ¶
Responses: default: genericError
200: civilianairportDBResponse
func (*Controller) GetLastCommitFromBackNb ¶
func (controller *Controller) GetLastCommitFromBackNb(c *gin.Context)
swagger:route GET /commitfrombacknb backrepo GetLastCommitFromBackNb
func (*Controller) GetLastPushFromFrontNb ¶
func (controller *Controller) GetLastPushFromFrontNb(c *gin.Context)
swagger:route GET /pushfromfrontnb backrepo GetLastPushFromFrontNb
func (*Controller) GetLiner ¶
func (controller *Controller) GetLiner(c *gin.Context)
GetLiner
swagger:route GET /liners/{ID} liners getLiner
Gets the details for a liner.
Responses: default: genericError
200: linerDBResponse
func (*Controller) GetLiners ¶
func (controller *Controller) GetLiners(c *gin.Context)
GetLiners
swagger:route GET /liners liners getLiners
Get all liners ¶
Responses: default: genericError
200: linerDBResponse
func (*Controller) GetMessage ¶
func (controller *Controller) GetMessage(c *gin.Context)
GetMessage
swagger:route GET /messages/{ID} messages getMessage
Gets the details for a message.
Responses: default: genericError
200: messageDBResponse
func (*Controller) GetMessages ¶
func (controller *Controller) GetMessages(c *gin.Context)
GetMessages
swagger:route GET /messages messages getMessages
Get all messages ¶
Responses: default: genericError
200: messageDBResponse
func (*Controller) GetOpsLine ¶
func (controller *Controller) GetOpsLine(c *gin.Context)
GetOpsLine
swagger:route GET /opslines/{ID} opslines getOpsLine
Gets the details for a opsline.
Responses: default: genericError
200: opslineDBResponse
func (*Controller) GetOpsLines ¶
func (controller *Controller) GetOpsLines(c *gin.Context)
GetOpsLines
swagger:route GET /opslines opslines getOpsLines
Get all opslines ¶
Responses: default: genericError
200: opslineDBResponse
func (*Controller) GetRadar ¶
func (controller *Controller) GetRadar(c *gin.Context)
GetRadar
swagger:route GET /radars/{ID} radars getRadar
Gets the details for a radar.
Responses: default: genericError
200: radarDBResponse
func (*Controller) GetRadars ¶
func (controller *Controller) GetRadars(c *gin.Context)
GetRadars
swagger:route GET /radars radars getRadars
Get all radars ¶
Responses: default: genericError
200: radarDBResponse
func (*Controller) GetSatellite ¶
func (controller *Controller) GetSatellite(c *gin.Context)
GetSatellite
swagger:route GET /satellites/{ID} satellites getSatellite
Gets the details for a satellite.
Responses: default: genericError
200: satelliteDBResponse
func (*Controller) GetSatellites ¶
func (controller *Controller) GetSatellites(c *gin.Context)
GetSatellites
swagger:route GET /satellites satellites getSatellites
Get all satellites ¶
Responses: default: genericError
200: satelliteDBResponse
func (*Controller) GetScenario ¶
func (controller *Controller) GetScenario(c *gin.Context)
GetScenario
swagger:route GET /scenarios/{ID} scenarios getScenario
Gets the details for a scenario.
Responses: default: genericError
200: scenarioDBResponse
func (*Controller) GetScenarios ¶
func (controller *Controller) GetScenarios(c *gin.Context)
GetScenarios
swagger:route GET /scenarios scenarios getScenarios
Get all scenarios ¶
Responses: default: genericError
200: scenarioDBResponse
func (*Controller) PostCivilianAirport ¶
func (controller *Controller) PostCivilianAirport(c *gin.Context)
PostCivilianAirport
swagger:route POST /civilianairports civilianairports postCivilianAirport
Creates a civilianairport
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostLiner ¶
func (controller *Controller) PostLiner(c *gin.Context)
PostLiner
swagger:route POST /liners liners postLiner
Creates a liner
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostMessage ¶
func (controller *Controller) PostMessage(c *gin.Context)
PostMessage
swagger:route POST /messages messages postMessage
Creates a message
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostOpsLine ¶
func (controller *Controller) PostOpsLine(c *gin.Context)
PostOpsLine
swagger:route POST /opslines opslines postOpsLine
Creates a opsline
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostRadar ¶
func (controller *Controller) PostRadar(c *gin.Context)
PostRadar
swagger:route POST /radars radars postRadar
Creates a radar
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostSatellite ¶
func (controller *Controller) PostSatellite(c *gin.Context)
PostSatellite
swagger:route POST /satellites satellites postSatellite
Creates a satellite
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostScenario ¶
func (controller *Controller) PostScenario(c *gin.Context)
PostScenario
swagger:route POST /scenarios scenarios postScenario
Creates a scenario
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) UpdateCivilianAirport ¶
func (controller *Controller) UpdateCivilianAirport(c *gin.Context)
UpdateCivilianAirport
swagger:route PATCH /civilianairports/{ID} civilianairports updateCivilianAirport
Update a civilianairport ¶
Responses: default: genericError
200: civilianairportDBResponse
func (*Controller) UpdateLiner ¶
func (controller *Controller) UpdateLiner(c *gin.Context)
UpdateLiner
swagger:route PATCH /liners/{ID} liners updateLiner
Update a liner ¶
Responses: default: genericError
200: linerDBResponse
func (*Controller) UpdateMessage ¶
func (controller *Controller) UpdateMessage(c *gin.Context)
UpdateMessage
swagger:route PATCH /messages/{ID} messages updateMessage
Update a message ¶
Responses: default: genericError
200: messageDBResponse
func (*Controller) UpdateOpsLine ¶
func (controller *Controller) UpdateOpsLine(c *gin.Context)
UpdateOpsLine
swagger:route PATCH /opslines/{ID} opslines updateOpsLine
Update a opsline ¶
Responses: default: genericError
200: opslineDBResponse
func (*Controller) UpdateRadar ¶
func (controller *Controller) UpdateRadar(c *gin.Context)
UpdateRadar
swagger:route PATCH /radars/{ID} radars updateRadar
Update a radar ¶
Responses: default: genericError
200: radarDBResponse
func (*Controller) UpdateSatellite ¶
func (controller *Controller) UpdateSatellite(c *gin.Context)
UpdateSatellite
swagger:route PATCH /satellites/{ID} satellites updateSatellite
Update a satellite ¶
Responses: default: genericError
200: satelliteDBResponse
func (*Controller) UpdateScenario ¶
func (controller *Controller) UpdateScenario(c *gin.Context)
UpdateScenario
swagger:route PATCH /scenarios/{ID} scenarios updateScenario
Update a scenario ¶
Responses: default: genericError
200: scenarioDBResponse
type GenericError ¶
type GenericError struct { // in: body Body struct { Code int32 `json:"code"` Message string `json:"message"` } `json:"body"` }
A GenericError is the default error message that is generated. For certain status codes there are more appropriate error structures.
swagger:response genericError
type LinerID ¶
type LinerID struct { // The ID of the order // // in: path // required: true ID int64 }
An LinerID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getLiner updateLiner deleteLiner
type LinerInput ¶
LinerInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postLiner updateLiner
type MessageID ¶
type MessageID struct { // The ID of the order // // in: path // required: true ID int64 }
An MessageID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getMessage updateMessage deleteMessage
type MessageInput ¶
type MessageInput struct { // The Message to submit or modify // in: body Message *orm.MessageAPI }
MessageInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postMessage updateMessage
type OpsLineID ¶
type OpsLineID struct { // The ID of the order // // in: path // required: true ID int64 }
An OpsLineID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getOpsLine updateOpsLine deleteOpsLine
type OpsLineInput ¶
type OpsLineInput struct { // The OpsLine to submit or modify // in: body OpsLine *orm.OpsLineAPI }
OpsLineInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postOpsLine updateOpsLine
type RadarID ¶
type RadarID struct { // The ID of the order // // in: path // required: true ID int64 }
An RadarID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getRadar updateRadar deleteRadar
type RadarInput ¶
RadarInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postRadar updateRadar
type SatelliteID ¶
type SatelliteID struct { // The ID of the order // // in: path // required: true ID int64 }
An SatelliteID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getSatellite updateSatellite deleteSatellite
type SatelliteInput ¶
type SatelliteInput struct { // The Satellite to submit or modify // in: body Satellite *orm.SatelliteAPI }
SatelliteInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postSatellite updateSatellite
type ScenarioID ¶
type ScenarioID struct { // The ID of the order // // in: path // required: true ID int64 }
An ScenarioID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getScenario updateScenario deleteScenario
type ScenarioInput ¶
type ScenarioInput struct { // The Scenario to submit or modify // in: body Scenario *orm.ScenarioAPI }
ScenarioInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postScenario updateScenario
type ValidationError ¶
type ValidationError struct { // in: body Body struct { Code int32 `json:"code"` Message string `json:"message"` Field string `json:"field"` } `json:"body"` }
A ValidationError is an that is generated for validation failures. It has the same fields as a generic error but adds a Field property.
swagger:response validationError