controllers

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 ButtonID
• type ButtonInput
• type Controller
  • func GetController() *Controller
  • func (controller *Controller) AddBackRepo(backRepo *tree_orm.BackRepoStruct, stackPath string)
  • func (controller *Controller) DeleteButton(c *gin.Context)
  • func (controller *Controller) DeleteNode(c *gin.Context)
  • func (controller *Controller) DeleteSVGIcon(c *gin.Context)
  • func (controller *Controller) DeleteTree(c *gin.Context)
  • func (controller *Controller) GetButton(c *gin.Context)
  • func (controller *Controller) GetButtons(c *gin.Context)
  • func (controller *Controller) GetLastCommitFromBackNb(c *gin.Context)
  • func (controller *Controller) GetLastPushFromFrontNb(c *gin.Context)
  • func (controller *Controller) GetNode(c *gin.Context)
  • func (controller *Controller) GetNodes(c *gin.Context)
  • func (controller *Controller) GetSVGIcon(c *gin.Context)
  • func (controller *Controller) GetSVGIcons(c *gin.Context)
  • func (controller *Controller) GetTree(c *gin.Context)
  • func (controller *Controller) GetTrees(c *gin.Context)
  • func (controller *Controller) PostButton(c *gin.Context)
  • func (controller *Controller) PostNode(c *gin.Context)
  • func (controller *Controller) PostSVGIcon(c *gin.Context)
  • func (controller *Controller) PostTree(c *gin.Context)
  • func (controller *Controller) UpdateButton(c *gin.Context)
  • func (controller *Controller) UpdateNode(c *gin.Context)
  • func (controller *Controller) UpdateSVGIcon(c *gin.Context)
  • func (controller *Controller) UpdateTree(c *gin.Context)
• type GenericError
• type NodeID
• type NodeInput
• type SVGIconID
• type SVGIconInput
• type TreeID
• type TreeInput
• type ValidationError

Functions

func Register

func Register(r *gin.Engine)

Types

type ButtonID

type ButtonID struct {
	// The ID of the order
	//
	// in: path
	// required: true
	ID int64
}

An ButtonID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getButton updateButton deleteButton

type ButtonInput

type ButtonInput struct {
	// The Button to submit or modify
	// in: body
	Button *orm.ButtonAPI
}

ButtonInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postButton updateButton

type Controller

type Controller struct {

	// Map_BackRepos is the map to the backRepo instance according to the stack instance path
	Map_BackRepos map[string]*tree_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 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 *tree_orm.BackRepoStruct, stackPath string)

func (*Controller) DeleteButton

func (controller *Controller) DeleteButton(c *gin.Context)

DeleteButton

swagger:route DELETE /buttons/{ID} buttons deleteButton

Delete a button

default: genericError

200: buttonDBResponse

func (*Controller) DeleteNode

func (controller *Controller) DeleteNode(c *gin.Context)

DeleteNode

swagger:route DELETE /nodes/{ID} nodes deleteNode

Delete a node

default: genericError

200: nodeDBResponse

func (*Controller) DeleteSVGIcon

func (controller *Controller) DeleteSVGIcon(c *gin.Context)

DeleteSVGIcon

swagger:route DELETE /svgicons/{ID} svgicons deleteSVGIcon

Delete a svgicon

default: genericError

200: svgiconDBResponse

func (*Controller) DeleteTree

func (controller *Controller) DeleteTree(c *gin.Context)

DeleteTree

swagger:route DELETE /trees/{ID} trees deleteTree

Delete a tree

default: genericError

200: treeDBResponse

func (*Controller) GetButton

func (controller *Controller) GetButton(c *gin.Context)

GetButton

swagger:route GET /buttons/{ID} buttons getButton

Gets the details for a button.

Responses: default: genericError

200: buttonDBResponse

func (*Controller) GetButtons

func (controller *Controller) GetButtons(c *gin.Context)

GetButtons

swagger:route GET /buttons buttons getButtons

Get all buttons

Responses: default: genericError

200: buttonDBResponse

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) GetNode

func (controller *Controller) GetNode(c *gin.Context)

GetNode

swagger:route GET /nodes/{ID} nodes getNode

Gets the details for a node.

Responses: default: genericError

200: nodeDBResponse

func (*Controller) GetNodes

func (controller *Controller) GetNodes(c *gin.Context)

GetNodes

swagger:route GET /nodes nodes getNodes

Get all nodes

Responses: default: genericError

200: nodeDBResponse

func (*Controller) GetSVGIcon

func (controller *Controller) GetSVGIcon(c *gin.Context)

GetSVGIcon

swagger:route GET /svgicons/{ID} svgicons getSVGIcon

Gets the details for a svgicon.

Responses: default: genericError

200: svgiconDBResponse

func (*Controller) GetSVGIcons

func (controller *Controller) GetSVGIcons(c *gin.Context)

GetSVGIcons

swagger:route GET /svgicons svgicons getSVGIcons

Get all svgicons

Responses: default: genericError

200: svgiconDBResponse

func (*Controller) GetTree

func (controller *Controller) GetTree(c *gin.Context)

GetTree

swagger:route GET /trees/{ID} trees getTree

Gets the details for a tree.

Responses: default: genericError

200: treeDBResponse

func (*Controller) GetTrees

func (controller *Controller) GetTrees(c *gin.Context)

GetTrees

swagger:route GET /trees trees getTrees

Get all trees

Responses: default: genericError

200: treeDBResponse

func (*Controller) PostButton

func (controller *Controller) PostButton(c *gin.Context)

PostButton

swagger:route POST /buttons buttons postButton

Creates a button

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostNode

func (controller *Controller) PostNode(c *gin.Context)

PostNode

swagger:route POST /nodes nodes postNode

Creates a node

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostSVGIcon

func (controller *Controller) PostSVGIcon(c *gin.Context)

PostSVGIcon

swagger:route POST /svgicons svgicons postSVGIcon

Creates a svgicon

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostTree

func (controller *Controller) PostTree(c *gin.Context)

PostTree

swagger:route POST /trees trees postTree

Creates a tree

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) UpdateButton

func (controller *Controller) UpdateButton(c *gin.Context)

UpdateButton

swagger:route PATCH /buttons/{ID} buttons updateButton

Update a button

Responses: default: genericError

200: buttonDBResponse

func (*Controller) UpdateNode

func (controller *Controller) UpdateNode(c *gin.Context)

UpdateNode

swagger:route PATCH /nodes/{ID} nodes updateNode

Update a node

Responses: default: genericError

200: nodeDBResponse

func (*Controller) UpdateSVGIcon

func (controller *Controller) UpdateSVGIcon(c *gin.Context)

UpdateSVGIcon

swagger:route PATCH /svgicons/{ID} svgicons updateSVGIcon

Update a svgicon

Responses: default: genericError

200: svgiconDBResponse

func (*Controller) UpdateTree

func (controller *Controller) UpdateTree(c *gin.Context)

UpdateTree

swagger:route PATCH /trees/{ID} trees updateTree

Update a tree

Responses: default: genericError

200: treeDBResponse

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 NodeID

type NodeID struct {
	// The ID of the order
	//
	// in: path
	// required: true
	ID int64
}

An NodeID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getNode updateNode deleteNode

type NodeInput

type NodeInput struct {
	// The Node to submit or modify
	// in: body
	Node *orm.NodeAPI
}

NodeInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postNode updateNode

type SVGIconID

type SVGIconID struct {
	// The ID of the order
	//
	// in: path
	// required: true
	ID int64
}

An SVGIconID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getSVGIcon updateSVGIcon deleteSVGIcon

type SVGIconInput

type SVGIconInput struct {
	// The SVGIcon to submit or modify
	// in: body
	SVGIcon *orm.SVGIconAPI
}

SVGIconInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postSVGIcon updateSVGIcon

type TreeID

type TreeID struct {
	// The ID of the order
	//
	// in: path
	// required: true
	ID int64
}

An TreeID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getTree updateTree deleteTree

type TreeInput

type TreeInput struct {
	// The Tree to submit or modify
	// in: body
	Tree *orm.TreeAPI
}

TreeInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postTree updateTree

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