api

Documentation

Index

• type Field
• type Handlers
  • func NewHandlers(dal dal.Dal) *Handlers
  • func (h *Handlers) CreateFields(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
  • func (h *Handlers) DeleteField(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
  • func (h *Handlers) ImportIssue(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
  • func (h *Handlers) ImportIssueCommit(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
  • func (h *Handlers) ImportIssueRepoCommit(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
  • func (h *Handlers) ListFields(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)

Types

type Field

type Field struct {
	ColumnName  string `json:"columnName" example:"x_column_varchar"`
	DisplayName string `json:"displayName" example:"department"`
	DataType    string `json:"dataType" example:"varchar(255)"`
	Description string `json:"description" example:"more details about the column"`
}

type Handlers

type Handlers struct {
	// contains filtered or unexported fields
}

func NewHandlers

func NewHandlers(dal dal.Dal) *Handlers

func (*Handlers) CreateFields

func (h *Handlers) CreateFields(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)

CreateFields create a customized field @Summary create a customized field @Description create a customized field @Tags plugins/customize @Param table path string true "the table name" @Param request body Field true "request body" @Success 200 {object} fieldResponse "Success" @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/customize/{table}/fields [POST]

func (*Handlers) DeleteField

func (h *Handlers) DeleteField(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)

DeleteField delete a customized fields @Summary return all customized fields @Description return all customized fields @Tags plugins/customize @Param table path string true "the table name" @Param field path string true "the column to be deleted" @Success 200 {object} shared.ApiBody "Success" @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/customize/{table}/fields/{field} [DELETE]

func (*Handlers) ImportIssue

func (h *Handlers) ImportIssue(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)

ImportIssue accepts a CSV file, parses and saves it to the database @Summary Upload issues.csv file @Description Upload issues.csv file. 3 tables(boards, issues, board_issues) would be affected. @Tags plugins/customize @Accept multipart/form-data @Param boardId formData string true "the ID of the board" @Param boardName formData string true "the name of the board" @Param file formData file true "select file to upload" @Produce json @Success 200 @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/customize/csvfiles/issues.csv [post]

func (*Handlers) ImportIssueCommit

func (h *Handlers) ImportIssueCommit(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)

ImportIssueCommit accepts a CSV file, parses and saves it to the database @Summary Upload issue_commits.csv file @Description Upload issue_commits.csv file @Tags plugins/customize @Accept multipart/form-data @Param boardId formData string true "the ID of the board" @Param file formData file true "select file to upload" @Produce json @Success 200 @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/customize/csvfiles/issue_commits.csv [post]

func (*Handlers) ImportIssueRepoCommit

func (h *Handlers) ImportIssueRepoCommit(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)

ImportIssueRepoCommit accepts a CSV file, parses and saves it to the database @Summary Upload issue_repo_commits.csv file @Description Upload issue_repo_commits.csv file @Tags plugins/customize @Accept multipart/form-data @Param boardId formData string true "the ID of the board" @Param file formData file true "select file to upload" @Produce json @Success 200 @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/customize/csvfiles/issue_repo_commits.csv [post]

func (*Handlers) ListFields

func (h *Handlers) ListFields(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)

ListFields return all customized fields @Summary return all customized fields @Description return all customized fieldsh @Tags plugins/customize @Param table path string true "the table name" @Success 200 {object} []fieldResponse "Success" @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/customize/{table}/fields [GET]