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

Index

• func Register(r *gin.Engine)
• type ButtonID
• type ButtonInput
• type Controller
  • func GetController() *Controller
  • func (controller *Controller) AddBackRepo(backRepo *button_orm.BackRepoStruct, stackPath string)
  • func (controller *Controller) DeleteButton(c *gin.Context)
  • func (controller *Controller) DeleteGroup(c *gin.Context)
  • func (controller *Controller) DeleteLayout(c *gin.Context)
  • func (controller *Controller) GetButton(c *gin.Context)
  • func (controller *Controller) GetButtons(c *gin.Context)
  • func (controller *Controller) GetGroup(c *gin.Context)
  • func (controller *Controller) GetGroups(c *gin.Context)
  • func (controller *Controller) GetLastCommitFromBackNb(c *gin.Context)
  • func (controller *Controller) GetLastPushFromFrontNb(c *gin.Context)
  • func (controller *Controller) GetLayout(c *gin.Context)
  • func (controller *Controller) GetLayouts(c *gin.Context)
  • func (controller *Controller) PostButton(c *gin.Context)
  • func (controller *Controller) PostGroup(c *gin.Context)
  • func (controller *Controller) PostLayout(c *gin.Context)
  • func (controller *Controller) UpdateButton(c *gin.Context)
  • func (controller *Controller) UpdateGroup(c *gin.Context)
  • func (controller *Controller) UpdateLayout(c *gin.Context)
• type GenericError
• type GroupID
• type GroupInput
• type LayoutID
• type LayoutInput
• 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]*button_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 *button_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) DeleteGroup

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

DeleteGroup

swagger:route DELETE /groups/{ID} groups deleteGroup

Delete a group

default: genericError

200: groupDBResponse

func (*Controller) DeleteLayout

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

DeleteLayout

swagger:route DELETE /layouts/{ID} layouts deleteLayout

Delete a layout

default: genericError

200: layoutDBResponse

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

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

GetGroup

swagger:route GET /groups/{ID} groups getGroup

Gets the details for a group.

Responses: default: genericError

200: groupDBResponse

func (*Controller) GetGroups

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

GetGroups

swagger:route GET /groups groups getGroups

Get all groups

Responses: default: genericError

200: groupDBResponse

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

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

GetLayout

swagger:route GET /layouts/{ID} layouts getLayout

Gets the details for a layout.

Responses: default: genericError

200: layoutDBResponse

func (*Controller) GetLayouts

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

GetLayouts

swagger:route GET /layouts layouts getLayouts

Get all layouts

Responses: default: genericError

200: layoutDBResponse

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

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

PostGroup

swagger:route POST /groups groups postGroup

Creates a group

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostLayout

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

PostLayout

swagger:route POST /layouts layouts postLayout

Creates a layout

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

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

UpdateGroup

swagger:route PATCH /groups/{ID} groups updateGroup

Update a group

Responses: default: genericError

200: groupDBResponse

func (*Controller) UpdateLayout

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

UpdateLayout

swagger:route PATCH /layouts/{ID} layouts updateLayout

Update a layout

Responses: default: genericError

200: layoutDBResponse

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 GroupID

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

An GroupID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getGroup updateGroup deleteGroup

type GroupInput

type GroupInput struct {
	// The Group to submit or modify
	// in: body
	Group *orm.GroupAPI
}

GroupInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postGroup updateGroup

type LayoutID

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

An LayoutID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getLayout updateLayout deleteLayout

type LayoutInput

type LayoutInput struct {
	// The Layout to submit or modify
	// in: body
	Layout *orm.LayoutAPI
}

LayoutInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postLayout updateLayout

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