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 (controller *Controller) AddBackRepo(backRepo *xlsx_orm.BackRepoStruct, stackPath string)
- func (controller *Controller) DeleteDisplaySelection(c *gin.Context)
- func (controller *Controller) DeleteXLCell(c *gin.Context)
- func (controller *Controller) DeleteXLFile(c *gin.Context)
- func (controller *Controller) DeleteXLRow(c *gin.Context)
- func (controller *Controller) DeleteXLSheet(c *gin.Context)
- func (controller *Controller) GetDisplaySelection(c *gin.Context)
- func (controller *Controller) GetDisplaySelections(c *gin.Context)
- func (controller *Controller) GetLastCommitFromBackNb(c *gin.Context)
- func (controller *Controller) GetLastPushFromFrontNb(c *gin.Context)
- func (controller *Controller) GetXLCell(c *gin.Context)
- func (controller *Controller) GetXLCells(c *gin.Context)
- func (controller *Controller) GetXLFile(c *gin.Context)
- func (controller *Controller) GetXLFiles(c *gin.Context)
- func (controller *Controller) GetXLRow(c *gin.Context)
- func (controller *Controller) GetXLRows(c *gin.Context)
- func (controller *Controller) GetXLSheet(c *gin.Context)
- func (controller *Controller) GetXLSheets(c *gin.Context)
- func (controller *Controller) PostDisplaySelection(c *gin.Context)
- func (controller *Controller) PostXLCell(c *gin.Context)
- func (controller *Controller) PostXLFile(c *gin.Context)
- func (controller *Controller) PostXLRow(c *gin.Context)
- func (controller *Controller) PostXLSheet(c *gin.Context)
- func (controller *Controller) UpdateDisplaySelection(c *gin.Context)
- func (controller *Controller) UpdateXLCell(c *gin.Context)
- func (controller *Controller) UpdateXLFile(c *gin.Context)
- func (controller *Controller) UpdateXLRow(c *gin.Context)
- func (controller *Controller) UpdateXLSheet(c *gin.Context)
- type DisplaySelectionID
- type DisplaySelectionInput
- type GenericError
- type ValidationError
- type XLCellID
- type XLCellInput
- type XLFileID
- type XLFileInput
- type XLRowID
- type XLRowInput
- type XLSheetID
- type XLSheetInput
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]*xlsx_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 *xlsx_orm.BackRepoStruct, stackPath string)
func (*Controller) DeleteDisplaySelection ¶
func (controller *Controller) DeleteDisplaySelection(c *gin.Context)
DeleteDisplaySelection
swagger:route DELETE /displayselections/{ID} displayselections deleteDisplaySelection
Delete a displayselection ¶
default: genericError
200: displayselectionDBResponse
func (*Controller) DeleteXLCell ¶
func (controller *Controller) DeleteXLCell(c *gin.Context)
DeleteXLCell
swagger:route DELETE /xlcells/{ID} xlcells deleteXLCell
Delete a xlcell ¶
default: genericError
200: xlcellDBResponse
func (*Controller) DeleteXLFile ¶
func (controller *Controller) DeleteXLFile(c *gin.Context)
DeleteXLFile
swagger:route DELETE /xlfiles/{ID} xlfiles deleteXLFile
Delete a xlfile ¶
default: genericError
200: xlfileDBResponse
func (*Controller) DeleteXLRow ¶
func (controller *Controller) DeleteXLRow(c *gin.Context)
DeleteXLRow
swagger:route DELETE /xlrows/{ID} xlrows deleteXLRow
Delete a xlrow ¶
default: genericError
200: xlrowDBResponse
func (*Controller) DeleteXLSheet ¶
func (controller *Controller) DeleteXLSheet(c *gin.Context)
DeleteXLSheet
swagger:route DELETE /xlsheets/{ID} xlsheets deleteXLSheet
Delete a xlsheet ¶
default: genericError
200: xlsheetDBResponse
func (*Controller) GetDisplaySelection ¶
func (controller *Controller) GetDisplaySelection(c *gin.Context)
GetDisplaySelection
swagger:route GET /displayselections/{ID} displayselections getDisplaySelection
Gets the details for a displayselection.
Responses: default: genericError
200: displayselectionDBResponse
func (*Controller) GetDisplaySelections ¶
func (controller *Controller) GetDisplaySelections(c *gin.Context)
GetDisplaySelections
swagger:route GET /displayselections displayselections getDisplaySelections
Get all displayselections ¶
Responses: default: genericError
200: displayselectionDBResponse
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) GetXLCell ¶
func (controller *Controller) GetXLCell(c *gin.Context)
GetXLCell
swagger:route GET /xlcells/{ID} xlcells getXLCell
Gets the details for a xlcell.
Responses: default: genericError
200: xlcellDBResponse
func (*Controller) GetXLCells ¶
func (controller *Controller) GetXLCells(c *gin.Context)
GetXLCells
swagger:route GET /xlcells xlcells getXLCells
Get all xlcells ¶
Responses: default: genericError
200: xlcellDBResponse
func (*Controller) GetXLFile ¶
func (controller *Controller) GetXLFile(c *gin.Context)
GetXLFile
swagger:route GET /xlfiles/{ID} xlfiles getXLFile
Gets the details for a xlfile.
Responses: default: genericError
200: xlfileDBResponse
func (*Controller) GetXLFiles ¶
func (controller *Controller) GetXLFiles(c *gin.Context)
GetXLFiles
swagger:route GET /xlfiles xlfiles getXLFiles
Get all xlfiles ¶
Responses: default: genericError
200: xlfileDBResponse
func (*Controller) GetXLRow ¶
func (controller *Controller) GetXLRow(c *gin.Context)
GetXLRow
swagger:route GET /xlrows/{ID} xlrows getXLRow
Gets the details for a xlrow.
Responses: default: genericError
200: xlrowDBResponse
func (*Controller) GetXLRows ¶
func (controller *Controller) GetXLRows(c *gin.Context)
GetXLRows
swagger:route GET /xlrows xlrows getXLRows
Get all xlrows ¶
Responses: default: genericError
200: xlrowDBResponse
func (*Controller) GetXLSheet ¶
func (controller *Controller) GetXLSheet(c *gin.Context)
GetXLSheet
swagger:route GET /xlsheets/{ID} xlsheets getXLSheet
Gets the details for a xlsheet.
Responses: default: genericError
200: xlsheetDBResponse
func (*Controller) GetXLSheets ¶
func (controller *Controller) GetXLSheets(c *gin.Context)
GetXLSheets
swagger:route GET /xlsheets xlsheets getXLSheets
Get all xlsheets ¶
Responses: default: genericError
200: xlsheetDBResponse
func (*Controller) PostDisplaySelection ¶
func (controller *Controller) PostDisplaySelection(c *gin.Context)
PostDisplaySelection
swagger:route POST /displayselections displayselections postDisplaySelection
Creates a displayselection
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostXLCell ¶
func (controller *Controller) PostXLCell(c *gin.Context)
PostXLCell
swagger:route POST /xlcells xlcells postXLCell
Creates a xlcell
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostXLFile ¶
func (controller *Controller) PostXLFile(c *gin.Context)
PostXLFile
swagger:route POST /xlfiles xlfiles postXLFile
Creates a xlfile
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostXLRow ¶
func (controller *Controller) PostXLRow(c *gin.Context)
PostXLRow
swagger:route POST /xlrows xlrows postXLRow
Creates a xlrow
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostXLSheet ¶
func (controller *Controller) PostXLSheet(c *gin.Context)
PostXLSheet
swagger:route POST /xlsheets xlsheets postXLSheet
Creates a xlsheet
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) UpdateDisplaySelection ¶
func (controller *Controller) UpdateDisplaySelection(c *gin.Context)
UpdateDisplaySelection
swagger:route PATCH /displayselections/{ID} displayselections updateDisplaySelection
Update a displayselection ¶
Responses: default: genericError
200: displayselectionDBResponse
func (*Controller) UpdateXLCell ¶
func (controller *Controller) UpdateXLCell(c *gin.Context)
UpdateXLCell
swagger:route PATCH /xlcells/{ID} xlcells updateXLCell
Update a xlcell ¶
Responses: default: genericError
200: xlcellDBResponse
func (*Controller) UpdateXLFile ¶
func (controller *Controller) UpdateXLFile(c *gin.Context)
UpdateXLFile
swagger:route PATCH /xlfiles/{ID} xlfiles updateXLFile
Update a xlfile ¶
Responses: default: genericError
200: xlfileDBResponse
func (*Controller) UpdateXLRow ¶
func (controller *Controller) UpdateXLRow(c *gin.Context)
UpdateXLRow
swagger:route PATCH /xlrows/{ID} xlrows updateXLRow
Update a xlrow ¶
Responses: default: genericError
200: xlrowDBResponse
func (*Controller) UpdateXLSheet ¶
func (controller *Controller) UpdateXLSheet(c *gin.Context)
UpdateXLSheet
swagger:route PATCH /xlsheets/{ID} xlsheets updateXLSheet
Update a xlsheet ¶
Responses: default: genericError
200: xlsheetDBResponse
type DisplaySelectionID ¶
type DisplaySelectionID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An DisplaySelectionID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getDisplaySelection updateDisplaySelection deleteDisplaySelection
type DisplaySelectionInput ¶
type DisplaySelectionInput struct {
// The DisplaySelection to submit or modify
// in: body
DisplaySelection *orm.DisplaySelectionAPI
}
DisplaySelectionInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postDisplaySelection updateDisplaySelection
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 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
type XLCellID ¶
type XLCellID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An XLCellID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getXLCell updateXLCell deleteXLCell
type XLCellInput ¶
XLCellInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postXLCell updateXLCell
type XLFileID ¶
type XLFileID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An XLFileID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getXLFile updateXLFile deleteXLFile
type XLFileInput ¶
XLFileInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postXLFile updateXLFile
type XLRowID ¶
type XLRowID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An XLRowID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getXLRow updateXLRow deleteXLRow
type XLRowInput ¶
XLRowInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postXLRow updateXLRow
type XLSheetID ¶
type XLSheetID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An XLSheetID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getXLSheet updateXLSheet deleteXLSheet
type XLSheetInput ¶
type XLSheetInput struct {
// The XLSheet to submit or modify
// in: body
XLSheet *orm.XLSheetAPI
}
XLSheetInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postXLSheet updateXLSheet