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

generated code - do not edit

Index

• func Register(r *gin.Engine)
• type AnnotationID
• type AnnotationInput
• type ComplexContentID
• type ComplexContentInput
• type ComplexTypeID
• type ComplexTypeInput
• type Controller
  • func GetController() *Controller
  • func (controller *Controller) AddBackRepo(backRepo *alt_orm.BackRepoStruct, stackPath string)
  • func (controller *Controller) DeleteAnnotation(c *gin.Context)
  • func (controller *Controller) DeleteComplexContent(c *gin.Context)
  • func (controller *Controller) DeleteComplexType(c *gin.Context)
  • func (controller *Controller) DeleteDocumentation(c *gin.Context)
  • func (controller *Controller) DeleteSchema(c *gin.Context)
  • func (controller *Controller) GetAnnotation(c *gin.Context)
  • func (controller *Controller) GetAnnotations(c *gin.Context)
  • func (controller *Controller) GetComplexContent(c *gin.Context)
  • func (controller *Controller) GetComplexContents(c *gin.Context)
  • func (controller *Controller) GetComplexType(c *gin.Context)
  • func (controller *Controller) GetComplexTypes(c *gin.Context)
  • func (controller *Controller) GetDocumentation(c *gin.Context)
  • func (controller *Controller) GetDocumentations(c *gin.Context)
  • func (controller *Controller) GetLastCommitFromBackNb(c *gin.Context)
  • func (controller *Controller) GetLastPushFromFrontNb(c *gin.Context)
  • func (controller *Controller) GetSchema(c *gin.Context)
  • func (controller *Controller) GetSchemas(c *gin.Context)
  • func (controller *Controller) PostAnnotation(c *gin.Context)
  • func (controller *Controller) PostComplexContent(c *gin.Context)
  • func (controller *Controller) PostComplexType(c *gin.Context)
  • func (controller *Controller) PostDocumentation(c *gin.Context)
  • func (controller *Controller) PostSchema(c *gin.Context)
  • func (controller *Controller) UpdateAnnotation(c *gin.Context)
  • func (controller *Controller) UpdateComplexContent(c *gin.Context)
  • func (controller *Controller) UpdateComplexType(c *gin.Context)
  • func (controller *Controller) UpdateDocumentation(c *gin.Context)
  • func (controller *Controller) UpdateSchema(c *gin.Context)
• type DocumentationID
• type DocumentationInput
• type GenericError
• type SchemaID
• type SchemaInput
• type ValidationError

Functions

func Register

func Register(r *gin.Engine)

Types

type AnnotationID

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

An AnnotationID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getAnnotation updateAnnotation deleteAnnotation

type AnnotationInput

type AnnotationInput struct {
	// The Annotation to submit or modify
	// in: body
	Annotation *orm.AnnotationAPI
}

AnnotationInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postAnnotation updateAnnotation

type ComplexContentID

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

An ComplexContentID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getComplexContent updateComplexContent deleteComplexContent

type ComplexContentInput

type ComplexContentInput struct {
	// The ComplexContent to submit or modify
	// in: body
	ComplexContent *orm.ComplexContentAPI
}

ComplexContentInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postComplexContent updateComplexContent

type ComplexTypeID

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

An ComplexTypeID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getComplexType updateComplexType deleteComplexType

type ComplexTypeInput

type ComplexTypeInput struct {
	// The ComplexType to submit or modify
	// in: body
	ComplexType *orm.ComplexTypeAPI
}

ComplexTypeInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postComplexType updateComplexType

type Controller

type Controller struct {

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

func (*Controller) DeleteAnnotation

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

DeleteAnnotation

swagger:route DELETE /annotations/{ID} annotations deleteAnnotation

Delete a annotation

default: genericError

200: annotationDBResponse

func (*Controller) DeleteComplexContent

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

DeleteComplexContent

swagger:route DELETE /complexcontents/{ID} complexcontents deleteComplexContent

Delete a complexcontent

default: genericError

200: complexcontentDBResponse

func (*Controller) DeleteComplexType

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

DeleteComplexType

swagger:route DELETE /complextypes/{ID} complextypes deleteComplexType

Delete a complextype

default: genericError

200: complextypeDBResponse

func (*Controller) DeleteDocumentation

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

DeleteDocumentation

swagger:route DELETE /documentations/{ID} documentations deleteDocumentation

Delete a documentation

default: genericError

200: documentationDBResponse

func (*Controller) DeleteSchema

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

DeleteSchema

swagger:route DELETE /schemas/{ID} schemas deleteSchema

Delete a schema

default: genericError

200: schemaDBResponse

func (*Controller) GetAnnotation

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

GetAnnotation

swagger:route GET /annotations/{ID} annotations getAnnotation

Gets the details for a annotation.

Responses: default: genericError

200: annotationDBResponse

func (*Controller) GetAnnotations

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

GetAnnotations

swagger:route GET /annotations annotations getAnnotations

Get all annotations

Responses: default: genericError

200: annotationDBResponse

func (*Controller) GetComplexContent

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

GetComplexContent

swagger:route GET /complexcontents/{ID} complexcontents getComplexContent

Gets the details for a complexcontent.

Responses: default: genericError

200: complexcontentDBResponse

func (*Controller) GetComplexContents

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

GetComplexContents

swagger:route GET /complexcontents complexcontents getComplexContents

Get all complexcontents

Responses: default: genericError

200: complexcontentDBResponse

func (*Controller) GetComplexType

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

GetComplexType

swagger:route GET /complextypes/{ID} complextypes getComplexType

Gets the details for a complextype.

Responses: default: genericError

200: complextypeDBResponse

func (*Controller) GetComplexTypes

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

GetComplexTypes

swagger:route GET /complextypes complextypes getComplexTypes

Get all complextypes

Responses: default: genericError

200: complextypeDBResponse

func (*Controller) GetDocumentation

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

GetDocumentation

swagger:route GET /documentations/{ID} documentations getDocumentation

Gets the details for a documentation.

Responses: default: genericError

200: documentationDBResponse

func (*Controller) GetDocumentations

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

GetDocumentations

swagger:route GET /documentations documentations getDocumentations

Get all documentations

Responses: default: genericError

200: documentationDBResponse

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

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

GetSchema

swagger:route GET /schemas/{ID} schemas getSchema

Gets the details for a schema.

Responses: default: genericError

200: schemaDBResponse

func (*Controller) GetSchemas

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

GetSchemas

swagger:route GET /schemas schemas getSchemas

Get all schemas

Responses: default: genericError

200: schemaDBResponse

func (*Controller) PostAnnotation

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

PostAnnotation

swagger:route POST /annotations annotations postAnnotation

Creates a annotation

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostComplexContent

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

PostComplexContent

swagger:route POST /complexcontents complexcontents postComplexContent

Creates a complexcontent

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostComplexType

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

PostComplexType

swagger:route POST /complextypes complextypes postComplexType

Creates a complextype

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostDocumentation

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

PostDocumentation

swagger:route POST /documentations documentations postDocumentation

Creates a documentation

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostSchema

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

PostSchema

swagger:route POST /schemas schemas postSchema

Creates a schema

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) UpdateAnnotation

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

UpdateAnnotation

swagger:route PATCH /annotations/{ID} annotations updateAnnotation

Update a annotation

Responses: default: genericError

200: annotationDBResponse

func (*Controller) UpdateComplexContent

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

UpdateComplexContent

swagger:route PATCH /complexcontents/{ID} complexcontents updateComplexContent

Update a complexcontent

Responses: default: genericError

200: complexcontentDBResponse

func (*Controller) UpdateComplexType

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

UpdateComplexType

swagger:route PATCH /complextypes/{ID} complextypes updateComplexType

Update a complextype

Responses: default: genericError

200: complextypeDBResponse

func (*Controller) UpdateDocumentation

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

UpdateDocumentation

swagger:route PATCH /documentations/{ID} documentations updateDocumentation

Update a documentation

Responses: default: genericError

200: documentationDBResponse

func (*Controller) UpdateSchema

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

UpdateSchema

swagger:route PATCH /schemas/{ID} schemas updateSchema

Update a schema

Responses: default: genericError

200: schemaDBResponse

type DocumentationID

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

An DocumentationID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getDocumentation updateDocumentation deleteDocumentation

type DocumentationInput

type DocumentationInput struct {
	// The Documentation to submit or modify
	// in: body
	Documentation *orm.DocumentationAPI
}

DocumentationInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postDocumentation updateDocumentation

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 SchemaID

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

An SchemaID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getSchema updateSchema deleteSchema

type SchemaInput

type SchemaInput struct {
	// The Schema to submit or modify
	// in: body
	Schema *orm.SchemaAPI
}

SchemaInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postSchema updateSchema

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