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
Index ¶
- func Register(r *gin.Engine)
- type Controller
- func (controller *Controller) AddBackRepo(backRepo *tone_orm.BackRepoStruct, stackPath string)
- func (controller *Controller) DeleteFreqency(c *gin.Context)
- func (controller *Controller) DeleteNote(c *gin.Context)
- func (controller *Controller) DeletePlayer(c *gin.Context)
- func (controller *Controller) GetFreqency(c *gin.Context)
- func (controller *Controller) GetFreqencys(c *gin.Context)
- func (controller *Controller) GetLastCommitFromBackNb(c *gin.Context)
- func (controller *Controller) GetLastPushFromFrontNb(c *gin.Context)
- func (controller *Controller) GetNote(c *gin.Context)
- func (controller *Controller) GetNotes(c *gin.Context)
- func (controller *Controller) GetPlayer(c *gin.Context)
- func (controller *Controller) GetPlayers(c *gin.Context)
- func (controller *Controller) PostFreqency(c *gin.Context)
- func (controller *Controller) PostNote(c *gin.Context)
- func (controller *Controller) PostPlayer(c *gin.Context)
- func (controller *Controller) UpdateFreqency(c *gin.Context)
- func (controller *Controller) UpdateNote(c *gin.Context)
- func (controller *Controller) UpdatePlayer(c *gin.Context)
- type FreqencyID
- type FreqencyInput
- type GenericError
- type NoteID
- type NoteInput
- type PlayerID
- type PlayerInput
- type ValidationError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
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]*tone_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 *tone_orm.BackRepoStruct, stackPath string)
func (*Controller) DeleteFreqency ¶
func (controller *Controller) DeleteFreqency(c *gin.Context)
DeleteFreqency
swagger:route DELETE /freqencys/{ID} freqencys deleteFreqency
Delete a freqency ¶
default: genericError
200: freqencyDBResponse
func (*Controller) DeleteNote ¶
func (controller *Controller) DeleteNote(c *gin.Context)
DeleteNote
swagger:route DELETE /notes/{ID} notes deleteNote
Delete a note ¶
default: genericError
200: noteDBResponse
func (*Controller) DeletePlayer ¶
func (controller *Controller) DeletePlayer(c *gin.Context)
DeletePlayer
swagger:route DELETE /players/{ID} players deletePlayer
Delete a player ¶
default: genericError
200: playerDBResponse
func (*Controller) GetFreqency ¶
func (controller *Controller) GetFreqency(c *gin.Context)
GetFreqency
swagger:route GET /freqencys/{ID} freqencys getFreqency
Gets the details for a freqency.
Responses: default: genericError
200: freqencyDBResponse
func (*Controller) GetFreqencys ¶
func (controller *Controller) GetFreqencys(c *gin.Context)
GetFreqencys
swagger:route GET /freqencys freqencys getFreqencys
Get all freqencys ¶
Responses: default: genericError
200: freqencyDBResponse
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) GetNote ¶
func (controller *Controller) GetNote(c *gin.Context)
GetNote
swagger:route GET /notes/{ID} notes getNote
Gets the details for a note.
Responses: default: genericError
200: noteDBResponse
func (*Controller) GetNotes ¶
func (controller *Controller) GetNotes(c *gin.Context)
GetNotes
swagger:route GET /notes notes getNotes
Get all notes ¶
Responses: default: genericError
200: noteDBResponse
func (*Controller) GetPlayer ¶
func (controller *Controller) GetPlayer(c *gin.Context)
GetPlayer
swagger:route GET /players/{ID} players getPlayer
Gets the details for a player.
Responses: default: genericError
200: playerDBResponse
func (*Controller) GetPlayers ¶
func (controller *Controller) GetPlayers(c *gin.Context)
GetPlayers
swagger:route GET /players players getPlayers
Get all players ¶
Responses: default: genericError
200: playerDBResponse
func (*Controller) PostFreqency ¶
func (controller *Controller) PostFreqency(c *gin.Context)
PostFreqency
swagger:route POST /freqencys freqencys postFreqency
Creates a freqency
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostNote ¶
func (controller *Controller) PostNote(c *gin.Context)
PostNote
swagger:route POST /notes notes postNote
Creates a note
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostPlayer ¶
func (controller *Controller) PostPlayer(c *gin.Context)
PostPlayer
swagger:route POST /players players postPlayer
Creates a player
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) UpdateFreqency ¶
func (controller *Controller) UpdateFreqency(c *gin.Context)
UpdateFreqency
swagger:route PATCH /freqencys/{ID} freqencys updateFreqency
Update a freqency ¶
Responses: default: genericError
200: freqencyDBResponse
func (*Controller) UpdateNote ¶
func (controller *Controller) UpdateNote(c *gin.Context)
UpdateNote
swagger:route PATCH /notes/{ID} notes updateNote
Update a note ¶
Responses: default: genericError
200: noteDBResponse
func (*Controller) UpdatePlayer ¶
func (controller *Controller) UpdatePlayer(c *gin.Context)
UpdatePlayer
swagger:route PATCH /players/{ID} players updatePlayer
Update a player ¶
Responses: default: genericError
200: playerDBResponse
type FreqencyID ¶
type FreqencyID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An FreqencyID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getFreqency updateFreqency deleteFreqency
type FreqencyInput ¶
type FreqencyInput struct {
// The Freqency to submit or modify
// in: body
Freqency *orm.FreqencyAPI
}
FreqencyInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postFreqency updateFreqency
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 NoteID ¶
type NoteID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An NoteID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getNote updateNote deleteNote
type NoteInput ¶
NoteInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postNote updateNote
type PlayerID ¶
type PlayerID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An PlayerID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getPlayer updatePlayer deletePlayer
type PlayerInput ¶
PlayerInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postPlayer updatePlayer
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