controllers

package
v0.0.0-...-3fb929e Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 29, 2024 License: MIT Imports: 9 Imported by: 0

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

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

Constants

This section is empty.

Variables

This section is empty.

Functions

func Register

func Register(r *gin.Engine)

Types

type BodyID

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

An BodyID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getBody updateBody deleteBody

type BodyInput

type BodyInput struct {
	// The Body to submit or modify
	// in: body
	Body *orm.BodyAPI
}

BodyInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postBody updateBody

type Controller

type Controller struct {

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

func (*Controller) DeleteBody

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

DeleteBody

swagger:route DELETE /bodys/{ID} bodys deleteBody

Delete a body

default: genericError

200: bodyDBResponse

func (*Controller) DeleteDocument

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

DeleteDocument

swagger:route DELETE /documents/{ID} documents deleteDocument

Delete a document

default: genericError

200: documentDBResponse

func (*Controller) DeleteDocx

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

DeleteDocx

swagger:route DELETE /docxs/{ID} docxs deleteDocx

Delete a docx

default: genericError

200: docxDBResponse

func (*Controller) DeleteFile

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

DeleteFile

swagger:route DELETE /files/{ID} files deleteFile

Delete a file

default: genericError

200: fileDBResponse

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

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

DeleteParagraph

swagger:route DELETE /paragraphs/{ID} paragraphs deleteParagraph

Delete a paragraph

default: genericError

200: paragraphDBResponse

func (*Controller) DeleteParagraphProperties

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

DeleteParagraphProperties

swagger:route DELETE /paragraphpropertiess/{ID} paragraphpropertiess deleteParagraphProperties

Delete a paragraphproperties

default: genericError

200: paragraphpropertiesDBResponse

func (*Controller) DeleteParagraphStyle

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

DeleteParagraphStyle

swagger:route DELETE /paragraphstyles/{ID} paragraphstyles deleteParagraphStyle

Delete a paragraphstyle

default: genericError

200: paragraphstyleDBResponse

func (*Controller) DeleteRune

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

DeleteRune

swagger:route DELETE /runes/{ID} runes deleteRune

Delete a rune

default: genericError

200: runeDBResponse

func (*Controller) DeleteRuneProperties

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

DeleteRuneProperties

swagger:route DELETE /runepropertiess/{ID} runepropertiess deleteRuneProperties

Delete a runeproperties

default: genericError

200: runepropertiesDBResponse

func (*Controller) DeleteTable

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

DeleteTable

swagger:route DELETE /tables/{ID} tables deleteTable

Delete a table

default: genericError

200: tableDBResponse

func (*Controller) DeleteTableColumn

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

DeleteTableColumn

swagger:route DELETE /tablecolumns/{ID} tablecolumns deleteTableColumn

Delete a tablecolumn

default: genericError

200: tablecolumnDBResponse

func (*Controller) DeleteTableProperties

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

DeleteTableProperties

swagger:route DELETE /tablepropertiess/{ID} tablepropertiess deleteTableProperties

Delete a tableproperties

default: genericError

200: tablepropertiesDBResponse

func (*Controller) DeleteTableRow

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

DeleteTableRow

swagger:route DELETE /tablerows/{ID} tablerows deleteTableRow

Delete a tablerow

default: genericError

200: tablerowDBResponse

func (*Controller) DeleteTableStyle

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

DeleteTableStyle

swagger:route DELETE /tablestyles/{ID} tablestyles deleteTableStyle

Delete a tablestyle

default: genericError

200: tablestyleDBResponse

func (*Controller) DeleteText

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

DeleteText

swagger:route DELETE /texts/{ID} texts deleteText

Delete a text

default: genericError

200: textDBResponse

func (*Controller) GetBody

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

GetBody

swagger:route GET /bodys/{ID} bodys getBody

Gets the details for a body.

Responses: default: genericError

200: bodyDBResponse

func (*Controller) GetBodys

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

GetBodys

swagger:route GET /bodys bodys getBodys

Get all bodys

Responses: default: genericError

200: bodyDBResponse

func (*Controller) GetDocument

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

GetDocument

swagger:route GET /documents/{ID} documents getDocument

Gets the details for a document.

Responses: default: genericError

200: documentDBResponse

func (*Controller) GetDocuments

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

GetDocuments

swagger:route GET /documents documents getDocuments

Get all documents

Responses: default: genericError

200: documentDBResponse

func (*Controller) GetDocx

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

GetDocx

swagger:route GET /docxs/{ID} docxs getDocx

Gets the details for a docx.

Responses: default: genericError

200: docxDBResponse

func (*Controller) GetDocxs

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

GetDocxs

swagger:route GET /docxs docxs getDocxs

Get all docxs

Responses: default: genericError

200: docxDBResponse

func (*Controller) GetFile

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

GetFile

swagger:route GET /files/{ID} files getFile

Gets the details for a file.

Responses: default: genericError

200: fileDBResponse

func (*Controller) GetFiles

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

GetFiles

swagger:route GET /files files getFiles

Get all files

Responses: default: genericError

200: fileDBResponse

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

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

GetParagraph

swagger:route GET /paragraphs/{ID} paragraphs getParagraph

Gets the details for a paragraph.

Responses: default: genericError

200: paragraphDBResponse

func (*Controller) GetParagraphProperties

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

GetParagraphProperties

swagger:route GET /paragraphpropertiess/{ID} paragraphpropertiess getParagraphProperties

Gets the details for a paragraphproperties.

Responses: default: genericError

200: paragraphpropertiesDBResponse

func (*Controller) GetParagraphPropertiess

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

GetParagraphPropertiess

swagger:route GET /paragraphpropertiess paragraphpropertiess getParagraphPropertiess

Get all paragraphpropertiess

Responses: default: genericError

200: paragraphpropertiesDBResponse

func (*Controller) GetParagraphStyle

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

GetParagraphStyle

swagger:route GET /paragraphstyles/{ID} paragraphstyles getParagraphStyle

Gets the details for a paragraphstyle.

Responses: default: genericError

200: paragraphstyleDBResponse

func (*Controller) GetParagraphStyles

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

GetParagraphStyles

swagger:route GET /paragraphstyles paragraphstyles getParagraphStyles

Get all paragraphstyles

Responses: default: genericError

200: paragraphstyleDBResponse

func (*Controller) GetParagraphs

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

GetParagraphs

swagger:route GET /paragraphs paragraphs getParagraphs

Get all paragraphs

Responses: default: genericError

200: paragraphDBResponse

func (*Controller) GetRune

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

GetRune

swagger:route GET /runes/{ID} runes getRune

Gets the details for a rune.

Responses: default: genericError

200: runeDBResponse

func (*Controller) GetRuneProperties

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

GetRuneProperties

swagger:route GET /runepropertiess/{ID} runepropertiess getRuneProperties

Gets the details for a runeproperties.

Responses: default: genericError

200: runepropertiesDBResponse

func (*Controller) GetRunePropertiess

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

GetRunePropertiess

swagger:route GET /runepropertiess runepropertiess getRunePropertiess

Get all runepropertiess

Responses: default: genericError

200: runepropertiesDBResponse

func (*Controller) GetRunes

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

GetRunes

swagger:route GET /runes runes getRunes

Get all runes

Responses: default: genericError

200: runeDBResponse

func (*Controller) GetTable

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

GetTable

swagger:route GET /tables/{ID} tables getTable

Gets the details for a table.

Responses: default: genericError

200: tableDBResponse

func (*Controller) GetTableColumn

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

GetTableColumn

swagger:route GET /tablecolumns/{ID} tablecolumns getTableColumn

Gets the details for a tablecolumn.

Responses: default: genericError

200: tablecolumnDBResponse

func (*Controller) GetTableColumns

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

GetTableColumns

swagger:route GET /tablecolumns tablecolumns getTableColumns

Get all tablecolumns

Responses: default: genericError

200: tablecolumnDBResponse

func (*Controller) GetTableProperties

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

GetTableProperties

swagger:route GET /tablepropertiess/{ID} tablepropertiess getTableProperties

Gets the details for a tableproperties.

Responses: default: genericError

200: tablepropertiesDBResponse

func (*Controller) GetTablePropertiess

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

GetTablePropertiess

swagger:route GET /tablepropertiess tablepropertiess getTablePropertiess

Get all tablepropertiess

Responses: default: genericError

200: tablepropertiesDBResponse

func (*Controller) GetTableRow

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

GetTableRow

swagger:route GET /tablerows/{ID} tablerows getTableRow

Gets the details for a tablerow.

Responses: default: genericError

200: tablerowDBResponse

func (*Controller) GetTableRows

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

GetTableRows

swagger:route GET /tablerows tablerows getTableRows

Get all tablerows

Responses: default: genericError

200: tablerowDBResponse

func (*Controller) GetTableStyle

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

GetTableStyle

swagger:route GET /tablestyles/{ID} tablestyles getTableStyle

Gets the details for a tablestyle.

Responses: default: genericError

200: tablestyleDBResponse

func (*Controller) GetTableStyles

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

GetTableStyles

swagger:route GET /tablestyles tablestyles getTableStyles

Get all tablestyles

Responses: default: genericError

200: tablestyleDBResponse

func (*Controller) GetTables

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

GetTables

swagger:route GET /tables tables getTables

Get all tables

Responses: default: genericError

200: tableDBResponse

func (*Controller) GetText

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

GetText

swagger:route GET /texts/{ID} texts getText

Gets the details for a text.

Responses: default: genericError

200: textDBResponse

func (*Controller) GetTexts

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

GetTexts

swagger:route GET /texts texts getTexts

Get all texts

Responses: default: genericError

200: textDBResponse

func (*Controller) PostBody

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

PostBody

swagger:route POST /bodys bodys postBody

Creates a body

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostDocument

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

PostDocument

swagger:route POST /documents documents postDocument

Creates a document

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostDocx

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

PostDocx

swagger:route POST /docxs docxs postDocx

Creates a docx

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostFile

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

PostFile

swagger:route POST /files files postFile

Creates a file

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

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

PostParagraph

swagger:route POST /paragraphs paragraphs postParagraph

Creates a paragraph

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostParagraphProperties

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

PostParagraphProperties

swagger:route POST /paragraphpropertiess paragraphpropertiess postParagraphProperties

Creates a paragraphproperties

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostParagraphStyle

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

PostParagraphStyle

swagger:route POST /paragraphstyles paragraphstyles postParagraphStyle

Creates a paragraphstyle

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostRune

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

PostRune

swagger:route POST /runes runes postRune

Creates a rune

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostRuneProperties

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

PostRuneProperties

swagger:route POST /runepropertiess runepropertiess postRuneProperties

Creates a runeproperties

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostTable

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

PostTable

swagger:route POST /tables tables postTable

Creates a table

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostTableColumn

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

PostTableColumn

swagger:route POST /tablecolumns tablecolumns postTableColumn

Creates a tablecolumn

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostTableProperties

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

PostTableProperties

swagger:route POST /tablepropertiess tablepropertiess postTableProperties

Creates a tableproperties

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostTableRow

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

PostTableRow

swagger:route POST /tablerows tablerows postTableRow

Creates a tablerow

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostTableStyle

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

PostTableStyle

swagger:route POST /tablestyles tablestyles postTableStyle

Creates a tablestyle

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) PostText

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

PostText

swagger:route POST /texts texts postText

Creates a text

Consumes:
- application/json

Produces:
- application/json

Responses:
  200: nodeDBResponse

func (*Controller) UpdateBody

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

UpdateBody

swagger:route PATCH /bodys/{ID} bodys updateBody

Update a body

Responses: default: genericError

200: bodyDBResponse

func (*Controller) UpdateDocument

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

UpdateDocument

swagger:route PATCH /documents/{ID} documents updateDocument

Update a document

Responses: default: genericError

200: documentDBResponse

func (*Controller) UpdateDocx

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

UpdateDocx

swagger:route PATCH /docxs/{ID} docxs updateDocx

Update a docx

Responses: default: genericError

200: docxDBResponse

func (*Controller) UpdateFile

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

UpdateFile

swagger:route PATCH /files/{ID} files updateFile

Update a file

Responses: default: genericError

200: fileDBResponse

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

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

UpdateParagraph

swagger:route PATCH /paragraphs/{ID} paragraphs updateParagraph

Update a paragraph

Responses: default: genericError

200: paragraphDBResponse

func (*Controller) UpdateParagraphProperties

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

UpdateParagraphProperties

swagger:route PATCH /paragraphpropertiess/{ID} paragraphpropertiess updateParagraphProperties

Update a paragraphproperties

Responses: default: genericError

200: paragraphpropertiesDBResponse

func (*Controller) UpdateParagraphStyle

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

UpdateParagraphStyle

swagger:route PATCH /paragraphstyles/{ID} paragraphstyles updateParagraphStyle

Update a paragraphstyle

Responses: default: genericError

200: paragraphstyleDBResponse

func (*Controller) UpdateRune

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

UpdateRune

swagger:route PATCH /runes/{ID} runes updateRune

Update a rune

Responses: default: genericError

200: runeDBResponse

func (*Controller) UpdateRuneProperties

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

UpdateRuneProperties

swagger:route PATCH /runepropertiess/{ID} runepropertiess updateRuneProperties

Update a runeproperties

Responses: default: genericError

200: runepropertiesDBResponse

func (*Controller) UpdateTable

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

UpdateTable

swagger:route PATCH /tables/{ID} tables updateTable

Update a table

Responses: default: genericError

200: tableDBResponse

func (*Controller) UpdateTableColumn

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

UpdateTableColumn

swagger:route PATCH /tablecolumns/{ID} tablecolumns updateTableColumn

Update a tablecolumn

Responses: default: genericError

200: tablecolumnDBResponse

func (*Controller) UpdateTableProperties

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

UpdateTableProperties

swagger:route PATCH /tablepropertiess/{ID} tablepropertiess updateTableProperties

Update a tableproperties

Responses: default: genericError

200: tablepropertiesDBResponse

func (*Controller) UpdateTableRow

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

UpdateTableRow

swagger:route PATCH /tablerows/{ID} tablerows updateTableRow

Update a tablerow

Responses: default: genericError

200: tablerowDBResponse

func (*Controller) UpdateTableStyle

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

UpdateTableStyle

swagger:route PATCH /tablestyles/{ID} tablestyles updateTableStyle

Update a tablestyle

Responses: default: genericError

200: tablestyleDBResponse

func (*Controller) UpdateText

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

UpdateText

swagger:route PATCH /texts/{ID} texts updateText

Update a text

Responses: default: genericError

200: textDBResponse

type DocumentID

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

An DocumentID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getDocument updateDocument deleteDocument

type DocumentInput

type DocumentInput struct {
	// The Document to submit or modify
	// in: body
	Document *orm.DocumentAPI
}

DocumentInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postDocument updateDocument

type DocxID

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

An DocxID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getDocx updateDocx deleteDocx

type DocxInput

type DocxInput struct {
	// The Docx to submit or modify
	// in: body
	Docx *orm.DocxAPI
}

DocxInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postDocx updateDocx

type FileID

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

An FileID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getFile updateFile deleteFile

type FileInput

type FileInput struct {
	// The File to submit or modify
	// in: body
	File *orm.FileAPI
}

FileInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postFile updateFile

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 ParagraphID

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

An ParagraphID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getParagraph updateParagraph deleteParagraph

type ParagraphInput

type ParagraphInput struct {
	// The Paragraph to submit or modify
	// in: body
	Paragraph *orm.ParagraphAPI
}

ParagraphInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postParagraph updateParagraph

type ParagraphPropertiesID

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

An ParagraphPropertiesID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getParagraphProperties updateParagraphProperties deleteParagraphProperties

type ParagraphPropertiesInput

type ParagraphPropertiesInput struct {
	// The ParagraphProperties to submit or modify
	// in: body
	ParagraphProperties *orm.ParagraphPropertiesAPI
}

ParagraphPropertiesInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postParagraphProperties updateParagraphProperties

type ParagraphStyleID

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

An ParagraphStyleID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getParagraphStyle updateParagraphStyle deleteParagraphStyle

type ParagraphStyleInput

type ParagraphStyleInput struct {
	// The ParagraphStyle to submit or modify
	// in: body
	ParagraphStyle *orm.ParagraphStyleAPI
}

ParagraphStyleInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postParagraphStyle updateParagraphStyle

type RuneID

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

An RuneID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getRune updateRune deleteRune

type RuneInput

type RuneInput struct {
	// The Rune to submit or modify
	// in: body
	Rune *orm.RuneAPI
}

RuneInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postRune updateRune

type RunePropertiesID

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

An RunePropertiesID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getRuneProperties updateRuneProperties deleteRuneProperties

type RunePropertiesInput

type RunePropertiesInput struct {
	// The RuneProperties to submit or modify
	// in: body
	RuneProperties *orm.RunePropertiesAPI
}

RunePropertiesInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postRuneProperties updateRuneProperties

type TableColumnID

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

An TableColumnID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getTableColumn updateTableColumn deleteTableColumn

type TableColumnInput

type TableColumnInput struct {
	// The TableColumn to submit or modify
	// in: body
	TableColumn *orm.TableColumnAPI
}

TableColumnInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postTableColumn updateTableColumn

type TableID

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

An TableID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getTable updateTable deleteTable

type TableInput

type TableInput struct {
	// The Table to submit or modify
	// in: body
	Table *orm.TableAPI
}

TableInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postTable updateTable

type TablePropertiesID

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

An TablePropertiesID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getTableProperties updateTableProperties deleteTableProperties

type TablePropertiesInput

type TablePropertiesInput struct {
	// The TableProperties to submit or modify
	// in: body
	TableProperties *orm.TablePropertiesAPI
}

TablePropertiesInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postTableProperties updateTableProperties

type TableRowID

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

An TableRowID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getTableRow updateTableRow deleteTableRow

type TableRowInput

type TableRowInput struct {
	// The TableRow to submit or modify
	// in: body
	TableRow *orm.TableRowAPI
}

TableRowInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postTableRow updateTableRow

type TableStyleID

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

An TableStyleID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getTableStyle updateTableStyle deleteTableStyle

type TableStyleInput

type TableStyleInput struct {
	// The TableStyle to submit or modify
	// in: body
	TableStyle *orm.TableStyleAPI
}

TableStyleInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postTableStyle updateTableStyle

type TextID

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

An TextID parameter model.

This is used for operations that want the ID of an order in the path swagger:parameters getText updateText deleteText

type TextInput

type TextInput struct {
	// The Text to submit or modify
	// in: body
	Text *orm.TextAPI
}

TextInput is a schema that can validate the user’s input to prevent us from getting invalid data swagger:parameters postText updateText

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL