Documentation
¶
Overview ¶
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 *cursor_orm.BackRepoStruct, stackPath string)
- func (controller *Controller) DeleteCursor(c *gin.Context)
- func (controller *Controller) GetCursor(c *gin.Context)
- func (controller *Controller) GetCursors(c *gin.Context)
- func (controller *Controller) GetLastCommitFromBackNb(c *gin.Context)
- func (controller *Controller) GetLastPushFromFrontNb(c *gin.Context)
- func (controller *Controller) PostCursor(c *gin.Context)
- func (controller *Controller) UpdateCursor(c *gin.Context)
- type CursorID
- type CursorInput
- type GenericError
- 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]*cursor_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 *cursor_orm.BackRepoStruct, stackPath string)
func (*Controller) DeleteCursor ¶
func (controller *Controller) DeleteCursor(c *gin.Context)
DeleteCursor
swagger:route DELETE /cursors/{ID} cursors deleteCursor
Delete a cursor ¶
default: genericError
200: cursorDBResponse
func (*Controller) GetCursor ¶
func (controller *Controller) GetCursor(c *gin.Context)
GetCursor
swagger:route GET /cursors/{ID} cursors getCursor
Gets the details for a cursor.
Responses: default: genericError
200: cursorDBResponse
func (*Controller) GetCursors ¶
func (controller *Controller) GetCursors(c *gin.Context)
GetCursors
swagger:route GET /cursors cursors getCursors
Get all cursors ¶
Responses: default: genericError
200: cursorDBResponse
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) PostCursor ¶
func (controller *Controller) PostCursor(c *gin.Context)
PostCursor
swagger:route POST /cursors cursors postCursor
Creates a cursor
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) UpdateCursor ¶
func (controller *Controller) UpdateCursor(c *gin.Context)
UpdateCursor
swagger:route PATCH /cursors/{ID} cursors updateCursor
Update a cursor ¶
Responses: default: genericError
200: cursorDBResponse
type CursorID ¶
type CursorID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An CursorID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getCursor updateCursor deleteCursor
type CursorInput ¶
CursorInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postCursor updateCursor
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
Source Files