controllers

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

Index

• func Register(r *gin.Engine)
• type Controller
  • func GetController() *Controller
  • func (controller *Controller) AddBackRepo(backRepo *gongsim_orm.BackRepoStruct, stackPath string)
  • func (controller *Controller) DeleteDummyAgent(c *gin.Context)
  • func (controller *Controller) DeleteEngine(c *gin.Context)
  • func (controller *Controller) DeleteEvent(c *gin.Context)
  • func (controller *Controller) DeleteGongsimCommand(c *gin.Context)
  • func (controller *Controller) DeleteGongsimStatus(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) GetGongsimCommand(c *gin.Context)
  • func (controller *Controller) GetGongsimCommands(c *gin.Context)
  • func (controller *Controller) GetGongsimStatus(c *gin.Context)
  • func (controller *Controller) GetGongsimStatuss(c *gin.Context)
  • func (controller *Controller) GetLastCommitFromBackNb(c *gin.Context)
  • func (controller *Controller) GetLastPushFromFrontNb(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) PostGongsimCommand(c *gin.Context)
  • func (controller *Controller) PostGongsimStatus(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) UpdateGongsimCommand(c *gin.Context)
  • func (controller *Controller) UpdateGongsimStatus(c *gin.Context)
• type DummyAgentID
• type DummyAgentInput
• type EngineID
• type EngineInput
• type EventID
• type EventInput
• type GenericError
• type GongsimCommandID
• type GongsimCommandInput
• type GongsimStatusID
• type GongsimStatusInput
• type ValidationError

Functions

func Register

func Register(r *gin.Engine)

Types

type Controller

type Controller struct {

	// Map_BackRepos is the map to the backRepo instance according to the stack instance path
	Map_BackRepos map[string]*gongsim_orm.BackRepoStruct
}

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 *gongsim_orm.BackRepoStruct, stackPath string)

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) DeleteGongsimCommand

func (controller *Controller) DeleteGongsimCommand(c *gin.Context)

DeleteGongsimCommand

swagger:route DELETE /gongsimcommands/{ID} gongsimcommands deleteGongsimCommand

Delete a gongsimcommand

default: genericError

200: gongsimcommandDBResponse

func (*Controller) DeleteGongsimStatus

func (controller *Controller) DeleteGongsimStatus(c *gin.Context)

DeleteGongsimStatus

swagger:route DELETE /gongsimstatuss/{ID} gongsimstatuss deleteGongsimStatus

Delete a gongsimstatus

default: genericError

200: gongsimstatusDBResponse

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) GetGongsimCommand

func (controller *Controller) GetGongsimCommand(c *gin.Context)

GetGongsimCommand

swagger:route GET /gongsimcommands/{ID} gongsimcommands getGongsimCommand

Gets the details for a gongsimcommand.

Responses: default: genericError

200: gongsimcommandDBResponse

func (*Controller) GetGongsimCommands

func (controller *Controller) GetGongsimCommands(c *gin.Context)

GetGongsimCommands

swagger:route GET /gongsimcommands gongsimcommands getGongsimCommands

Get all gongsimcommands

Responses: default: genericError

200: gongsimcommandDBResponse

func (*Controller) GetGongsimStatus

func (controller *Controller) GetGongsimStatus(c *gin.Context)

GetGongsimStatus

swagger:route GET /gongsimstatuss/{ID} gongsimstatuss getGongsimStatus

Gets the details for a gongsimstatus.

Responses: default: genericError

200: gongsimstatusDBResponse

func (*Controller) GetGongsimStatuss

func (controller *Controller) GetGongsimStatuss(c *gin.Context)

GetGongsimStatuss

swagger:route GET /gongsimstatuss gongsimstatuss getGongsimStatuss

Get all gongsimstatuss

Responses: default: genericError

200: gongsimstatusDBResponse

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) 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) PostGongsimCommand

func (controller *Controller) PostGongsimCommand(c *gin.Context)

PostGongsimCommand

swagger:route POST /gongsimcommands gongsimcommands postGongsimCommand

Creates a gongsimcommand

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostGongsimStatus

func (controller *Controller) PostGongsimStatus(c *gin.Context)

PostGongsimStatus

swagger:route POST /gongsimstatuss gongsimstatuss postGongsimStatus

Creates a gongsimstatus

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

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) UpdateGongsimCommand

func (controller *Controller) UpdateGongsimCommand(c *gin.Context)

UpdateGongsimCommand

swagger:route PATCH /gongsimcommands/{ID} gongsimcommands updateGongsimCommand

Update a gongsimcommand

Responses: default: genericError

200: gongsimcommandDBResponse

func (*Controller) UpdateGongsimStatus

func (controller *Controller) UpdateGongsimStatus(c *gin.Context)

UpdateGongsimStatus

swagger:route PATCH /gongsimstatuss/{ID} gongsimstatuss updateGongsimStatus

Update a gongsimstatus

Responses: default: genericError

200: gongsimstatusDBResponse

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

type EngineInput struct {
	// The Engine to submit or modify
	// in: body
	Engine *orm.EngineAPI
}

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

type EventInput struct {
	// The Event to submit or modify
	// in: body
	Event *orm.EventAPI
}

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 GongsimCommandID

type GongsimCommandID struct {
	// The ID of the order
	//
	// in: path
	// required: true
	ID int64
}

An GongsimCommandID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getGongsimCommand updateGongsimCommand deleteGongsimCommand

type GongsimCommandInput

type GongsimCommandInput struct {
	// The GongsimCommand to submit or modify
	// in: body
	GongsimCommand *orm.GongsimCommandAPI
}

GongsimCommandInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postGongsimCommand updateGongsimCommand

type GongsimStatusID

type GongsimStatusID struct {
	// The ID of the order
	//
	// in: path
	// required: true
	ID int64
}

An GongsimStatusID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getGongsimStatus updateGongsimStatus deleteGongsimStatus

type GongsimStatusInput

type GongsimStatusInput struct {
	// The GongsimStatus to submit or modify
	// in: body
	GongsimStatus *orm.GongsimStatusAPI
}

GongsimStatusInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postGongsimStatus updateGongsimStatus

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