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
Index ¶
- func Register(r *gin.Engine)
- type ContentID
- type ContentInput
- type Controller
- func (controller *Controller) AddBackRepo(backRepo *markdown_orm.BackRepoStruct, stackPath string)
- func (controller *Controller) DeleteContent(c *gin.Context)
- func (controller *Controller) DeleteJpgImage(c *gin.Context)
- func (controller *Controller) DeletePngImage(c *gin.Context)
- func (controller *Controller) DeleteSvgImage(c *gin.Context)
- func (controller *Controller) GetContent(c *gin.Context)
- func (controller *Controller) GetContents(c *gin.Context)
- func (controller *Controller) GetJpgImage(c *gin.Context)
- func (controller *Controller) GetJpgImages(c *gin.Context)
- func (controller *Controller) GetLastCommitFromBackNb(c *gin.Context)
- func (controller *Controller) GetLastPushFromFrontNb(c *gin.Context)
- func (controller *Controller) GetPngImage(c *gin.Context)
- func (controller *Controller) GetPngImages(c *gin.Context)
- func (controller *Controller) GetSvgImage(c *gin.Context)
- func (controller *Controller) GetSvgImages(c *gin.Context)
- func (controller *Controller) PostContent(c *gin.Context)
- func (controller *Controller) PostJpgImage(c *gin.Context)
- func (controller *Controller) PostPngImage(c *gin.Context)
- func (controller *Controller) PostSvgImage(c *gin.Context)
- func (controller *Controller) UpdateContent(c *gin.Context)
- func (controller *Controller) UpdateJpgImage(c *gin.Context)
- func (controller *Controller) UpdatePngImage(c *gin.Context)
- func (controller *Controller) UpdateSvgImage(c *gin.Context)
- type GenericError
- type JpgImageID
- type JpgImageInput
- type PngImageID
- type PngImageInput
- type SvgImageID
- type SvgImageInput
- type ValidationError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ContentID ¶
type ContentID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An ContentID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getContent updateContent deleteContent
type ContentInput ¶
type ContentInput struct {
// The Content to submit or modify
// in: body
Content *orm.ContentAPI
}
ContentInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postContent updateContent
type Controller ¶
type Controller struct {
// Map_BackRepos is the map to the backRepo instance according to the stack instance path
Map_BackRepos map[string]*markdown_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 *markdown_orm.BackRepoStruct, stackPath string)
func (*Controller) DeleteContent ¶
func (controller *Controller) DeleteContent(c *gin.Context)
DeleteContent
swagger:route DELETE /contents/{ID} contents deleteContent
Delete a content ¶
default: genericError
200: contentDBResponse
func (*Controller) DeleteJpgImage ¶
func (controller *Controller) DeleteJpgImage(c *gin.Context)
DeleteJpgImage
swagger:route DELETE /jpgimages/{ID} jpgimages deleteJpgImage
Delete a jpgimage ¶
default: genericError
200: jpgimageDBResponse
func (*Controller) DeletePngImage ¶
func (controller *Controller) DeletePngImage(c *gin.Context)
DeletePngImage
swagger:route DELETE /pngimages/{ID} pngimages deletePngImage
Delete a pngimage ¶
default: genericError
200: pngimageDBResponse
func (*Controller) DeleteSvgImage ¶
func (controller *Controller) DeleteSvgImage(c *gin.Context)
DeleteSvgImage
swagger:route DELETE /svgimages/{ID} svgimages deleteSvgImage
Delete a svgimage ¶
default: genericError
200: svgimageDBResponse
func (*Controller) GetContent ¶
func (controller *Controller) GetContent(c *gin.Context)
GetContent
swagger:route GET /contents/{ID} contents getContent
Gets the details for a content.
Responses: default: genericError
200: contentDBResponse
func (*Controller) GetContents ¶
func (controller *Controller) GetContents(c *gin.Context)
GetContents
swagger:route GET /contents contents getContents
Get all contents ¶
Responses: default: genericError
200: contentDBResponse
func (*Controller) GetJpgImage ¶
func (controller *Controller) GetJpgImage(c *gin.Context)
GetJpgImage
swagger:route GET /jpgimages/{ID} jpgimages getJpgImage
Gets the details for a jpgimage.
Responses: default: genericError
200: jpgimageDBResponse
func (*Controller) GetJpgImages ¶
func (controller *Controller) GetJpgImages(c *gin.Context)
GetJpgImages
swagger:route GET /jpgimages jpgimages getJpgImages
Get all jpgimages ¶
Responses: default: genericError
200: jpgimageDBResponse
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) GetPngImage ¶
func (controller *Controller) GetPngImage(c *gin.Context)
GetPngImage
swagger:route GET /pngimages/{ID} pngimages getPngImage
Gets the details for a pngimage.
Responses: default: genericError
200: pngimageDBResponse
func (*Controller) GetPngImages ¶
func (controller *Controller) GetPngImages(c *gin.Context)
GetPngImages
swagger:route GET /pngimages pngimages getPngImages
Get all pngimages ¶
Responses: default: genericError
200: pngimageDBResponse
func (*Controller) GetSvgImage ¶
func (controller *Controller) GetSvgImage(c *gin.Context)
GetSvgImage
swagger:route GET /svgimages/{ID} svgimages getSvgImage
Gets the details for a svgimage.
Responses: default: genericError
200: svgimageDBResponse
func (*Controller) GetSvgImages ¶
func (controller *Controller) GetSvgImages(c *gin.Context)
GetSvgImages
swagger:route GET /svgimages svgimages getSvgImages
Get all svgimages ¶
Responses: default: genericError
200: svgimageDBResponse
func (*Controller) PostContent ¶
func (controller *Controller) PostContent(c *gin.Context)
PostContent
swagger:route POST /contents contents postContent
Creates a content
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostJpgImage ¶
func (controller *Controller) PostJpgImage(c *gin.Context)
PostJpgImage
swagger:route POST /jpgimages jpgimages postJpgImage
Creates a jpgimage
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostPngImage ¶
func (controller *Controller) PostPngImage(c *gin.Context)
PostPngImage
swagger:route POST /pngimages pngimages postPngImage
Creates a pngimage
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostSvgImage ¶
func (controller *Controller) PostSvgImage(c *gin.Context)
PostSvgImage
swagger:route POST /svgimages svgimages postSvgImage
Creates a svgimage
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) UpdateContent ¶
func (controller *Controller) UpdateContent(c *gin.Context)
UpdateContent
swagger:route PATCH /contents/{ID} contents updateContent
Update a content ¶
Responses: default: genericError
200: contentDBResponse
func (*Controller) UpdateJpgImage ¶
func (controller *Controller) UpdateJpgImage(c *gin.Context)
UpdateJpgImage
swagger:route PATCH /jpgimages/{ID} jpgimages updateJpgImage
Update a jpgimage ¶
Responses: default: genericError
200: jpgimageDBResponse
func (*Controller) UpdatePngImage ¶
func (controller *Controller) UpdatePngImage(c *gin.Context)
UpdatePngImage
swagger:route PATCH /pngimages/{ID} pngimages updatePngImage
Update a pngimage ¶
Responses: default: genericError
200: pngimageDBResponse
func (*Controller) UpdateSvgImage ¶
func (controller *Controller) UpdateSvgImage(c *gin.Context)
UpdateSvgImage
swagger:route PATCH /svgimages/{ID} svgimages updateSvgImage
Update a svgimage ¶
Responses: default: genericError
200: svgimageDBResponse
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 JpgImageID ¶
type JpgImageID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An JpgImageID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getJpgImage updateJpgImage deleteJpgImage
type JpgImageInput ¶
type JpgImageInput struct {
// The JpgImage to submit or modify
// in: body
JpgImage *orm.JpgImageAPI
}
JpgImageInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postJpgImage updateJpgImage
type PngImageID ¶
type PngImageID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An PngImageID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getPngImage updatePngImage deletePngImage
type PngImageInput ¶
type PngImageInput struct {
// The PngImage to submit or modify
// in: body
PngImage *orm.PngImageAPI
}
PngImageInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postPngImage updatePngImage
type SvgImageID ¶
type SvgImageID struct {
// The ID of the order
//
// in: path
// required: true
ID int64
}
An SvgImageID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getSvgImage updateSvgImage deleteSvgImage
type SvgImageInput ¶
type SvgImageInput struct {
// The SvgImage to submit or modify
// in: body
SvgImage *orm.SvgImageAPI
}
SvgImageInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postSvgImage updateSvgImage
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