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
Index ¶
- func Register(r *gin.Engine)
- type CommandID
- type CommandInput
- type Controller
- func (controller *Controller) AddBackRepo(backRepo *sim_orm.BackRepoStruct, stackPath string)
- func (controller *Controller) DeleteCommand(c *gin.Context)
- func (controller *Controller) DeleteDummyAgent(c *gin.Context)
- func (controller *Controller) DeleteEngine(c *gin.Context)
- func (controller *Controller) DeleteEvent(c *gin.Context)
- func (controller *Controller) DeleteStatus(c *gin.Context)
- func (controller *Controller) DeleteUpdateState(c *gin.Context)
- func (controller *Controller) GetCommand(c *gin.Context)
- func (controller *Controller) GetCommands(c *gin.Context)
- func (controller *Controller) GetDummyAgent(c *gin.Context)
- func (controller *Controller) GetDummyAgents(c *gin.Context)
- func (controller *Controller) GetEngine(c *gin.Context)
- func (controller *Controller) GetEngines(c *gin.Context)
- func (controller *Controller) GetEvent(c *gin.Context)
- func (controller *Controller) GetEvents(c *gin.Context)
- func (controller *Controller) GetLastCommitFromBackNb(c *gin.Context)
- func (controller *Controller) GetLastPushFromFrontNb(c *gin.Context)
- func (controller *Controller) GetStatus(c *gin.Context)
- func (controller *Controller) GetStatuss(c *gin.Context)
- func (controller *Controller) GetUpdateState(c *gin.Context)
- func (controller *Controller) GetUpdateStates(c *gin.Context)
- func (controller *Controller) PostCommand(c *gin.Context)
- func (controller *Controller) PostDummyAgent(c *gin.Context)
- func (controller *Controller) PostEngine(c *gin.Context)
- func (controller *Controller) PostEvent(c *gin.Context)
- func (controller *Controller) PostStatus(c *gin.Context)
- func (controller *Controller) PostUpdateState(c *gin.Context)
- func (controller *Controller) UpdateCommand(c *gin.Context)
- func (controller *Controller) UpdateDummyAgent(c *gin.Context)
- func (controller *Controller) UpdateEngine(c *gin.Context)
- func (controller *Controller) UpdateEvent(c *gin.Context)
- func (controller *Controller) UpdateStatus(c *gin.Context)
- func (controller *Controller) UpdateUpdateState(c *gin.Context)
- type DummyAgentID
- type DummyAgentInput
- type EngineID
- type EngineInput
- type EventID
- type EventInput
- type GenericError
- type StatusID
- type StatusInput
- type UpdateStateID
- type UpdateStateInput
- type ValidationError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CommandID ¶
type CommandID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An CommandID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getCommand updateCommand deleteCommand
type CommandInput ¶
type CommandInput struct {
// The Command to submit or modify
// in: body
Command *orm.CommandAPI
}
CommandInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postCommand updateCommand
type Controller ¶
type Controller struct {
// Map_BackRepos is the map to the backRepo instance according to the stack instance path
Map_BackRepos map[string]*sim_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 Name parameters in the request the stack instance is the BackRepo instance
func GetController ¶
func GetController() *Controller
func (*Controller) AddBackRepo ¶
func (controller *Controller) AddBackRepo(backRepo *sim_orm.BackRepoStruct, stackPath string)
func (*Controller) DeleteCommand ¶
func (controller *Controller) DeleteCommand(c *gin.Context)
DeleteCommand
swagger:route DELETE /commands/{ID} commands deleteCommand
Delete a command ¶
default: genericError
200: commandDBResponse
func (*Controller) DeleteDummyAgent ¶
func (controller *Controller) DeleteDummyAgent(c *gin.Context)
DeleteDummyAgent
swagger:route DELETE /dummyagents/{ID} dummyagents deleteDummyAgent
Delete a dummyagent ¶
default: genericError
200: dummyagentDBResponse
func (*Controller) DeleteEngine ¶
func (controller *Controller) DeleteEngine(c *gin.Context)
DeleteEngine
swagger:route DELETE /engines/{ID} engines deleteEngine
Delete a engine ¶
default: genericError
200: engineDBResponse
func (*Controller) DeleteEvent ¶
func (controller *Controller) DeleteEvent(c *gin.Context)
DeleteEvent
swagger:route DELETE /events/{ID} events deleteEvent
Delete a event ¶
default: genericError
200: eventDBResponse
func (*Controller) DeleteStatus ¶
func (controller *Controller) DeleteStatus(c *gin.Context)
DeleteStatus
swagger:route DELETE /statuss/{ID} statuss deleteStatus
Delete a status ¶
default: genericError
200: statusDBResponse
func (*Controller) DeleteUpdateState ¶
func (controller *Controller) DeleteUpdateState(c *gin.Context)
DeleteUpdateState
swagger:route DELETE /updatestates/{ID} updatestates deleteUpdateState
Delete a updatestate ¶
default: genericError
200: updatestateDBResponse
func (*Controller) GetCommand ¶
func (controller *Controller) GetCommand(c *gin.Context)
GetCommand
swagger:route GET /commands/{ID} commands getCommand
Gets the details for a command.
Responses: default: genericError
200: commandDBResponse
func (*Controller) GetCommands ¶
func (controller *Controller) GetCommands(c *gin.Context)
GetCommands
swagger:route GET /commands commands getCommands
Get all commands ¶
Responses: default: genericError
200: commandDBResponse
func (*Controller) GetDummyAgent ¶
func (controller *Controller) GetDummyAgent(c *gin.Context)
GetDummyAgent
swagger:route GET /dummyagents/{ID} dummyagents getDummyAgent
Gets the details for a dummyagent.
Responses: default: genericError
200: dummyagentDBResponse
func (*Controller) GetDummyAgents ¶
func (controller *Controller) GetDummyAgents(c *gin.Context)
GetDummyAgents
swagger:route GET /dummyagents dummyagents getDummyAgents
Get all dummyagents ¶
Responses: default: genericError
200: dummyagentDBResponse
func (*Controller) GetEngine ¶
func (controller *Controller) GetEngine(c *gin.Context)
GetEngine
swagger:route GET /engines/{ID} engines getEngine
Gets the details for a engine.
Responses: default: genericError
200: engineDBResponse
func (*Controller) GetEngines ¶
func (controller *Controller) GetEngines(c *gin.Context)
GetEngines
swagger:route GET /engines engines getEngines
Get all engines ¶
Responses: default: genericError
200: engineDBResponse
func (*Controller) GetEvent ¶
func (controller *Controller) GetEvent(c *gin.Context)
GetEvent
swagger:route GET /events/{ID} events getEvent
Gets the details for a event.
Responses: default: genericError
200: eventDBResponse
func (*Controller) GetEvents ¶
func (controller *Controller) GetEvents(c *gin.Context)
GetEvents
swagger:route GET /events events getEvents
Get all events ¶
Responses: default: genericError
200: eventDBResponse
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) GetStatus ¶
func (controller *Controller) GetStatus(c *gin.Context)
GetStatus
swagger:route GET /statuss/{ID} statuss getStatus
Gets the details for a status.
Responses: default: genericError
200: statusDBResponse
func (*Controller) GetStatuss ¶
func (controller *Controller) GetStatuss(c *gin.Context)
GetStatuss
swagger:route GET /statuss statuss getStatuss
Get all statuss ¶
Responses: default: genericError
200: statusDBResponse
func (*Controller) GetUpdateState ¶
func (controller *Controller) GetUpdateState(c *gin.Context)
GetUpdateState
swagger:route GET /updatestates/{ID} updatestates getUpdateState
Gets the details for a updatestate.
Responses: default: genericError
200: updatestateDBResponse
func (*Controller) GetUpdateStates ¶
func (controller *Controller) GetUpdateStates(c *gin.Context)
GetUpdateStates
swagger:route GET /updatestates updatestates getUpdateStates
Get all updatestates ¶
Responses: default: genericError
200: updatestateDBResponse
func (*Controller) PostCommand ¶
func (controller *Controller) PostCommand(c *gin.Context)
PostCommand
swagger:route POST /commands commands postCommand
Creates a command
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostDummyAgent ¶
func (controller *Controller) PostDummyAgent(c *gin.Context)
PostDummyAgent
swagger:route POST /dummyagents dummyagents postDummyAgent
Creates a dummyagent
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostEngine ¶
func (controller *Controller) PostEngine(c *gin.Context)
PostEngine
swagger:route POST /engines engines postEngine
Creates a engine
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostEvent ¶
func (controller *Controller) PostEvent(c *gin.Context)
PostEvent
swagger:route POST /events events postEvent
Creates a event
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostStatus ¶
func (controller *Controller) PostStatus(c *gin.Context)
PostStatus
swagger:route POST /statuss statuss postStatus
Creates a status
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostUpdateState ¶
func (controller *Controller) PostUpdateState(c *gin.Context)
PostUpdateState
swagger:route POST /updatestates updatestates postUpdateState
Creates a updatestate
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) UpdateCommand ¶
func (controller *Controller) UpdateCommand(c *gin.Context)
UpdateCommand
swagger:route PATCH /commands/{ID} commands updateCommand
Update a command ¶
Responses: default: genericError
200: commandDBResponse
func (*Controller) UpdateDummyAgent ¶
func (controller *Controller) UpdateDummyAgent(c *gin.Context)
UpdateDummyAgent
swagger:route PATCH /dummyagents/{ID} dummyagents updateDummyAgent
Update a dummyagent ¶
Responses: default: genericError
200: dummyagentDBResponse
func (*Controller) UpdateEngine ¶
func (controller *Controller) UpdateEngine(c *gin.Context)
UpdateEngine
swagger:route PATCH /engines/{ID} engines updateEngine
Update a engine ¶
Responses: default: genericError
200: engineDBResponse
func (*Controller) UpdateEvent ¶
func (controller *Controller) UpdateEvent(c *gin.Context)
UpdateEvent
swagger:route PATCH /events/{ID} events updateEvent
Update a event ¶
Responses: default: genericError
200: eventDBResponse
func (*Controller) UpdateStatus ¶
func (controller *Controller) UpdateStatus(c *gin.Context)
UpdateStatus
swagger:route PATCH /statuss/{ID} statuss updateStatus
Update a status ¶
Responses: default: genericError
200: statusDBResponse
func (*Controller) UpdateUpdateState ¶
func (controller *Controller) UpdateUpdateState(c *gin.Context)
UpdateUpdateState
swagger:route PATCH /updatestates/{ID} updatestates updateUpdateState
Update a updatestate ¶
Responses: default: genericError
200: updatestateDBResponse
type DummyAgentID ¶
type DummyAgentID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An DummyAgentID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getDummyAgent updateDummyAgent deleteDummyAgent
type DummyAgentInput ¶
type DummyAgentInput struct {
// The DummyAgent to submit or modify
// in: body
DummyAgent *orm.DummyAgentAPI
}
DummyAgentInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postDummyAgent updateDummyAgent
type EngineID ¶
type EngineID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An EngineID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getEngine updateEngine deleteEngine
type EngineInput ¶
EngineInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postEngine updateEngine
type EventID ¶
type EventID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An EventID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getEvent updateEvent deleteEvent
type EventInput ¶
EventInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postEvent updateEvent
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 StatusID ¶
type StatusID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An StatusID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getStatus updateStatus deleteStatus
type StatusInput ¶
StatusInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postStatus updateStatus
type UpdateStateID ¶
type UpdateStateID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An UpdateStateID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getUpdateState updateUpdateState deleteUpdateState
type UpdateStateInput ¶
type UpdateStateInput struct {
// The UpdateState to submit or modify
// in: body
UpdateState *orm.UpdateStateAPI
}
UpdateStateInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postUpdateState updateUpdateState
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
Source Files