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
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 CircleID
- type CircleInput
- type Controller
- func (controller *Controller) AddBackRepo(backRepo *gongleaflet_orm.BackRepoStruct, stackPath string)
- func (controller *Controller) DeleteCircle(c *gin.Context)
- func (controller *Controller) DeleteDivIcon(c *gin.Context)
- func (controller *Controller) DeleteLayerGroup(c *gin.Context)
- func (controller *Controller) DeleteLayerGroupUse(c *gin.Context)
- func (controller *Controller) DeleteMapOptions(c *gin.Context)
- func (controller *Controller) DeleteMarker(c *gin.Context)
- func (controller *Controller) DeleteUserClick(c *gin.Context)
- func (controller *Controller) DeleteVLine(c *gin.Context)
- func (controller *Controller) DeleteVisualTrack(c *gin.Context)
- func (controller *Controller) GetCircle(c *gin.Context)
- func (controller *Controller) GetCircles(c *gin.Context)
- func (controller *Controller) GetDivIcon(c *gin.Context)
- func (controller *Controller) GetDivIcons(c *gin.Context)
- func (controller *Controller) GetLastCommitFromBackNb(c *gin.Context)
- func (controller *Controller) GetLastPushFromFrontNb(c *gin.Context)
- func (controller *Controller) GetLayerGroup(c *gin.Context)
- func (controller *Controller) GetLayerGroupUse(c *gin.Context)
- func (controller *Controller) GetLayerGroupUses(c *gin.Context)
- func (controller *Controller) GetLayerGroups(c *gin.Context)
- func (controller *Controller) GetMapOptions(c *gin.Context)
- func (controller *Controller) GetMapOptionss(c *gin.Context)
- func (controller *Controller) GetMarker(c *gin.Context)
- func (controller *Controller) GetMarkers(c *gin.Context)
- func (controller *Controller) GetUserClick(c *gin.Context)
- func (controller *Controller) GetUserClicks(c *gin.Context)
- func (controller *Controller) GetVLine(c *gin.Context)
- func (controller *Controller) GetVLines(c *gin.Context)
- func (controller *Controller) GetVisualTrack(c *gin.Context)
- func (controller *Controller) GetVisualTracks(c *gin.Context)
- func (controller *Controller) PostCircle(c *gin.Context)
- func (controller *Controller) PostDivIcon(c *gin.Context)
- func (controller *Controller) PostLayerGroup(c *gin.Context)
- func (controller *Controller) PostLayerGroupUse(c *gin.Context)
- func (controller *Controller) PostMapOptions(c *gin.Context)
- func (controller *Controller) PostMarker(c *gin.Context)
- func (controller *Controller) PostUserClick(c *gin.Context)
- func (controller *Controller) PostVLine(c *gin.Context)
- func (controller *Controller) PostVisualTrack(c *gin.Context)
- func (controller *Controller) UpdateCircle(c *gin.Context)
- func (controller *Controller) UpdateDivIcon(c *gin.Context)
- func (controller *Controller) UpdateLayerGroup(c *gin.Context)
- func (controller *Controller) UpdateLayerGroupUse(c *gin.Context)
- func (controller *Controller) UpdateMapOptions(c *gin.Context)
- func (controller *Controller) UpdateMarker(c *gin.Context)
- func (controller *Controller) UpdateUserClick(c *gin.Context)
- func (controller *Controller) UpdateVLine(c *gin.Context)
- func (controller *Controller) UpdateVisualTrack(c *gin.Context)
- type DivIconID
- type DivIconInput
- type GenericError
- type LayerGroupID
- type LayerGroupInput
- type LayerGroupUseID
- type LayerGroupUseInput
- type MapOptionsID
- type MapOptionsInput
- type MarkerID
- type MarkerInput
- type UserClickID
- type UserClickInput
- type VLineID
- type VLineInput
- type ValidationError
- type VisualTrackID
- type VisualTrackInput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CircleID ¶
type CircleID struct { // The ID of the order // // in: path // required: true ID int64 }
An CircleID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getCircle updateCircle deleteCircle
type CircleInput ¶
CircleInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postCircle updateCircle
type Controller ¶
type Controller struct { // Map_BackRepos is the map to the backRepo instance according to the stack instance path Map_BackRepos map[string]*gongleaflet_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 *gongleaflet_orm.BackRepoStruct, stackPath string)
func (*Controller) DeleteCircle ¶
func (controller *Controller) DeleteCircle(c *gin.Context)
DeleteCircle
swagger:route DELETE /circles/{ID} circles deleteCircle
Delete a circle ¶
default: genericError
200: circleDBResponse
func (*Controller) DeleteDivIcon ¶
func (controller *Controller) DeleteDivIcon(c *gin.Context)
DeleteDivIcon
swagger:route DELETE /divicons/{ID} divicons deleteDivIcon
Delete a divicon ¶
default: genericError
200: diviconDBResponse
func (*Controller) DeleteLayerGroup ¶
func (controller *Controller) DeleteLayerGroup(c *gin.Context)
DeleteLayerGroup
swagger:route DELETE /layergroups/{ID} layergroups deleteLayerGroup
Delete a layergroup ¶
default: genericError
200: layergroupDBResponse
func (*Controller) DeleteLayerGroupUse ¶
func (controller *Controller) DeleteLayerGroupUse(c *gin.Context)
DeleteLayerGroupUse
swagger:route DELETE /layergroupuses/{ID} layergroupuses deleteLayerGroupUse
Delete a layergroupuse ¶
default: genericError
200: layergroupuseDBResponse
func (*Controller) DeleteMapOptions ¶
func (controller *Controller) DeleteMapOptions(c *gin.Context)
DeleteMapOptions
swagger:route DELETE /mapoptionss/{ID} mapoptionss deleteMapOptions
Delete a mapoptions ¶
default: genericError
200: mapoptionsDBResponse
func (*Controller) DeleteMarker ¶
func (controller *Controller) DeleteMarker(c *gin.Context)
DeleteMarker
swagger:route DELETE /markers/{ID} markers deleteMarker
Delete a marker ¶
default: genericError
200: markerDBResponse
func (*Controller) DeleteUserClick ¶
func (controller *Controller) DeleteUserClick(c *gin.Context)
DeleteUserClick
swagger:route DELETE /userclicks/{ID} userclicks deleteUserClick
Delete a userclick ¶
default: genericError
200: userclickDBResponse
func (*Controller) DeleteVLine ¶
func (controller *Controller) DeleteVLine(c *gin.Context)
DeleteVLine
swagger:route DELETE /vlines/{ID} vlines deleteVLine
Delete a vline ¶
default: genericError
200: vlineDBResponse
func (*Controller) DeleteVisualTrack ¶
func (controller *Controller) DeleteVisualTrack(c *gin.Context)
DeleteVisualTrack
swagger:route DELETE /visualtracks/{ID} visualtracks deleteVisualTrack
Delete a visualtrack ¶
default: genericError
200: visualtrackDBResponse
func (*Controller) GetCircle ¶
func (controller *Controller) GetCircle(c *gin.Context)
GetCircle
swagger:route GET /circles/{ID} circles getCircle
Gets the details for a circle.
Responses: default: genericError
200: circleDBResponse
func (*Controller) GetCircles ¶
func (controller *Controller) GetCircles(c *gin.Context)
GetCircles
swagger:route GET /circles circles getCircles
Get all circles ¶
Responses: default: genericError
200: circleDBResponse
func (*Controller) GetDivIcon ¶
func (controller *Controller) GetDivIcon(c *gin.Context)
GetDivIcon
swagger:route GET /divicons/{ID} divicons getDivIcon
Gets the details for a divicon.
Responses: default: genericError
200: diviconDBResponse
func (*Controller) GetDivIcons ¶
func (controller *Controller) GetDivIcons(c *gin.Context)
GetDivIcons
swagger:route GET /divicons divicons getDivIcons
Get all divicons ¶
Responses: default: genericError
200: diviconDBResponse
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) GetLayerGroup ¶
func (controller *Controller) GetLayerGroup(c *gin.Context)
GetLayerGroup
swagger:route GET /layergroups/{ID} layergroups getLayerGroup
Gets the details for a layergroup.
Responses: default: genericError
200: layergroupDBResponse
func (*Controller) GetLayerGroupUse ¶
func (controller *Controller) GetLayerGroupUse(c *gin.Context)
GetLayerGroupUse
swagger:route GET /layergroupuses/{ID} layergroupuses getLayerGroupUse
Gets the details for a layergroupuse.
Responses: default: genericError
200: layergroupuseDBResponse
func (*Controller) GetLayerGroupUses ¶
func (controller *Controller) GetLayerGroupUses(c *gin.Context)
GetLayerGroupUses
swagger:route GET /layergroupuses layergroupuses getLayerGroupUses
Get all layergroupuses ¶
Responses: default: genericError
200: layergroupuseDBResponse
func (*Controller) GetLayerGroups ¶
func (controller *Controller) GetLayerGroups(c *gin.Context)
GetLayerGroups
swagger:route GET /layergroups layergroups getLayerGroups
Get all layergroups ¶
Responses: default: genericError
200: layergroupDBResponse
func (*Controller) GetMapOptions ¶
func (controller *Controller) GetMapOptions(c *gin.Context)
GetMapOptions
swagger:route GET /mapoptionss/{ID} mapoptionss getMapOptions
Gets the details for a mapoptions.
Responses: default: genericError
200: mapoptionsDBResponse
func (*Controller) GetMapOptionss ¶
func (controller *Controller) GetMapOptionss(c *gin.Context)
GetMapOptionss
swagger:route GET /mapoptionss mapoptionss getMapOptionss
Get all mapoptionss ¶
Responses: default: genericError
200: mapoptionsDBResponse
func (*Controller) GetMarker ¶
func (controller *Controller) GetMarker(c *gin.Context)
GetMarker
swagger:route GET /markers/{ID} markers getMarker
Gets the details for a marker.
Responses: default: genericError
200: markerDBResponse
func (*Controller) GetMarkers ¶
func (controller *Controller) GetMarkers(c *gin.Context)
GetMarkers
swagger:route GET /markers markers getMarkers
Get all markers ¶
Responses: default: genericError
200: markerDBResponse
func (*Controller) GetUserClick ¶
func (controller *Controller) GetUserClick(c *gin.Context)
GetUserClick
swagger:route GET /userclicks/{ID} userclicks getUserClick
Gets the details for a userclick.
Responses: default: genericError
200: userclickDBResponse
func (*Controller) GetUserClicks ¶
func (controller *Controller) GetUserClicks(c *gin.Context)
GetUserClicks
swagger:route GET /userclicks userclicks getUserClicks
Get all userclicks ¶
Responses: default: genericError
200: userclickDBResponse
func (*Controller) GetVLine ¶
func (controller *Controller) GetVLine(c *gin.Context)
GetVLine
swagger:route GET /vlines/{ID} vlines getVLine
Gets the details for a vline.
Responses: default: genericError
200: vlineDBResponse
func (*Controller) GetVLines ¶
func (controller *Controller) GetVLines(c *gin.Context)
GetVLines
swagger:route GET /vlines vlines getVLines
Get all vlines ¶
Responses: default: genericError
200: vlineDBResponse
func (*Controller) GetVisualTrack ¶
func (controller *Controller) GetVisualTrack(c *gin.Context)
GetVisualTrack
swagger:route GET /visualtracks/{ID} visualtracks getVisualTrack
Gets the details for a visualtrack.
Responses: default: genericError
200: visualtrackDBResponse
func (*Controller) GetVisualTracks ¶
func (controller *Controller) GetVisualTracks(c *gin.Context)
GetVisualTracks
swagger:route GET /visualtracks visualtracks getVisualTracks
Get all visualtracks ¶
Responses: default: genericError
200: visualtrackDBResponse
func (*Controller) PostCircle ¶
func (controller *Controller) PostCircle(c *gin.Context)
PostCircle
swagger:route POST /circles circles postCircle
Creates a circle
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostDivIcon ¶
func (controller *Controller) PostDivIcon(c *gin.Context)
PostDivIcon
swagger:route POST /divicons divicons postDivIcon
Creates a divicon
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostLayerGroup ¶
func (controller *Controller) PostLayerGroup(c *gin.Context)
PostLayerGroup
swagger:route POST /layergroups layergroups postLayerGroup
Creates a layergroup
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostLayerGroupUse ¶
func (controller *Controller) PostLayerGroupUse(c *gin.Context)
PostLayerGroupUse
swagger:route POST /layergroupuses layergroupuses postLayerGroupUse
Creates a layergroupuse
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostMapOptions ¶
func (controller *Controller) PostMapOptions(c *gin.Context)
PostMapOptions
swagger:route POST /mapoptionss mapoptionss postMapOptions
Creates a mapoptions
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostMarker ¶
func (controller *Controller) PostMarker(c *gin.Context)
PostMarker
swagger:route POST /markers markers postMarker
Creates a marker
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostUserClick ¶
func (controller *Controller) PostUserClick(c *gin.Context)
PostUserClick
swagger:route POST /userclicks userclicks postUserClick
Creates a userclick
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostVLine ¶
func (controller *Controller) PostVLine(c *gin.Context)
PostVLine
swagger:route POST /vlines vlines postVLine
Creates a vline
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) PostVisualTrack ¶
func (controller *Controller) PostVisualTrack(c *gin.Context)
PostVisualTrack
swagger:route POST /visualtracks visualtracks postVisualTrack
Creates a visualtrack
Consumes: - application/json Produces: - application/json Responses: 200: nodeDBResponse
func (*Controller) UpdateCircle ¶
func (controller *Controller) UpdateCircle(c *gin.Context)
UpdateCircle
swagger:route PATCH /circles/{ID} circles updateCircle
Update a circle ¶
Responses: default: genericError
200: circleDBResponse
func (*Controller) UpdateDivIcon ¶
func (controller *Controller) UpdateDivIcon(c *gin.Context)
UpdateDivIcon
swagger:route PATCH /divicons/{ID} divicons updateDivIcon
Update a divicon ¶
Responses: default: genericError
200: diviconDBResponse
func (*Controller) UpdateLayerGroup ¶
func (controller *Controller) UpdateLayerGroup(c *gin.Context)
UpdateLayerGroup
swagger:route PATCH /layergroups/{ID} layergroups updateLayerGroup
Update a layergroup ¶
Responses: default: genericError
200: layergroupDBResponse
func (*Controller) UpdateLayerGroupUse ¶
func (controller *Controller) UpdateLayerGroupUse(c *gin.Context)
UpdateLayerGroupUse
swagger:route PATCH /layergroupuses/{ID} layergroupuses updateLayerGroupUse
Update a layergroupuse ¶
Responses: default: genericError
200: layergroupuseDBResponse
func (*Controller) UpdateMapOptions ¶
func (controller *Controller) UpdateMapOptions(c *gin.Context)
UpdateMapOptions
swagger:route PATCH /mapoptionss/{ID} mapoptionss updateMapOptions
Update a mapoptions ¶
Responses: default: genericError
200: mapoptionsDBResponse
func (*Controller) UpdateMarker ¶
func (controller *Controller) UpdateMarker(c *gin.Context)
UpdateMarker
swagger:route PATCH /markers/{ID} markers updateMarker
Update a marker ¶
Responses: default: genericError
200: markerDBResponse
func (*Controller) UpdateUserClick ¶
func (controller *Controller) UpdateUserClick(c *gin.Context)
UpdateUserClick
swagger:route PATCH /userclicks/{ID} userclicks updateUserClick
Update a userclick ¶
Responses: default: genericError
200: userclickDBResponse
func (*Controller) UpdateVLine ¶
func (controller *Controller) UpdateVLine(c *gin.Context)
UpdateVLine
swagger:route PATCH /vlines/{ID} vlines updateVLine
Update a vline ¶
Responses: default: genericError
200: vlineDBResponse
func (*Controller) UpdateVisualTrack ¶
func (controller *Controller) UpdateVisualTrack(c *gin.Context)
UpdateVisualTrack
swagger:route PATCH /visualtracks/{ID} visualtracks updateVisualTrack
Update a visualtrack ¶
Responses: default: genericError
200: visualtrackDBResponse
type DivIconID ¶
type DivIconID struct { // The ID of the order // // in: path // required: true ID int64 }
An DivIconID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getDivIcon updateDivIcon deleteDivIcon
type DivIconInput ¶
type DivIconInput struct { // The DivIcon to submit or modify // in: body DivIcon *orm.DivIconAPI }
DivIconInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postDivIcon updateDivIcon
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 LayerGroupID ¶
type LayerGroupID struct { // The ID of the order // // in: path // required: true ID int64 }
An LayerGroupID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getLayerGroup updateLayerGroup deleteLayerGroup
type LayerGroupInput ¶
type LayerGroupInput struct { // The LayerGroup to submit or modify // in: body LayerGroup *orm.LayerGroupAPI }
LayerGroupInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postLayerGroup updateLayerGroup
type LayerGroupUseID ¶
type LayerGroupUseID struct { // The ID of the order // // in: path // required: true ID int64 }
An LayerGroupUseID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getLayerGroupUse updateLayerGroupUse deleteLayerGroupUse
type LayerGroupUseInput ¶
type LayerGroupUseInput struct { // The LayerGroupUse to submit or modify // in: body LayerGroupUse *orm.LayerGroupUseAPI }
LayerGroupUseInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postLayerGroupUse updateLayerGroupUse
type MapOptionsID ¶
type MapOptionsID struct { // The ID of the order // // in: path // required: true ID int64 }
An MapOptionsID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getMapOptions updateMapOptions deleteMapOptions
type MapOptionsInput ¶
type MapOptionsInput struct { // The MapOptions to submit or modify // in: body MapOptions *orm.MapOptionsAPI }
MapOptionsInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postMapOptions updateMapOptions
type MarkerID ¶
type MarkerID struct { // The ID of the order // // in: path // required: true ID int64 }
An MarkerID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getMarker updateMarker deleteMarker
type MarkerInput ¶
MarkerInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postMarker updateMarker
type UserClickID ¶
type UserClickID struct { // The ID of the order // // in: path // required: true ID int64 }
An UserClickID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getUserClick updateUserClick deleteUserClick
type UserClickInput ¶
type UserClickInput struct { // The UserClick to submit or modify // in: body UserClick *orm.UserClickAPI }
UserClickInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postUserClick updateUserClick
type VLineID ¶
type VLineID struct { // The ID of the order // // in: path // required: true ID int64 }
An VLineID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getVLine updateVLine deleteVLine
type VLineInput ¶
VLineInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postVLine updateVLine
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 VisualTrackID ¶
type VisualTrackID struct { // The ID of the order // // in: path // required: true ID int64 }
An VisualTrackID parameter model.
This is used for operations that want the ID of an order in the path swagger:parameters getVisualTrack updateVisualTrack deleteVisualTrack
type VisualTrackInput ¶
type VisualTrackInput struct { // The VisualTrack to submit or modify // in: body VisualTrack *orm.VisualTrackAPI }
VisualTrackInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postVisualTrack updateVisualTrack