api

package

v0.14.0-alpha1 Latest Latest Go to latest Published: Sep 22, 2022 License: Apache-2.0 Imports: 11 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/apache/incubator-devlake

Links

Open Source Insights

Documentation ¶

Index ¶

func DeleteConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
func GetConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
func Init(config *viper.Viper, logger core.Logger, database *gorm.DB)
func ListConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
func PatchConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
func PostConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
func TestConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)
type CodeTransformationRules
type TapdBlueprintSetting
type TapdPipelinePlan
type TicketTransformationRules

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DeleteConnection ¶

func DeleteConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)

@Summary delete a tapd connection @Description Delete a Tapd connection @Tags plugins/tapd @Success 200 {object} models.TapdConnection "Success" @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /plugins/tapd/connections/{connectionId} [DELETE]

func GetConnection ¶

func GetConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)

@Summary get tapd connection detail @Description Get Tapd connection detail @Tags plugins/tapd @Success 200 {object} models.TapdConnection "Success" @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /plugins/tapd/connections/{connectionId} [GET]

func Init ¶

func Init(config *viper.Viper, logger core.Logger, database *gorm.DB)

func ListConnections ¶

func ListConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)

@Summary get all tapd connections @Description Get all Tapd connections @Tags plugins/tapd @Success 200 {object} models.TapdConnection "Success" @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /plugins/tapd/connections [GET]

func PatchConnection ¶

func PatchConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)

@Summary patch tapd connection @Description Patch Tapd connection @Tags plugins/tapd @Param body body models.TapdConnection true "json body" @Success 200 {object} models.TapdConnection "Success" @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /plugins/tapd/connections/{connectionId} [PATCH]

func PostConnections ¶

func PostConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)

@Summary create tapd connection @Description Create Tapd connection @Tags plugins/tapd @Param body body models.TapdConnection true "json body" @Success 200 {object} models.TapdConnection "Success" @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /plugins/tapd/connections [POST]

func TestConnection ¶

func TestConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, errors.Error)

@Summary test tapd connection @Description Test Tapd Connection @Tags plugins/tapd @Param body body models.TestConnectionRequest true "json body" @Success 200 {object} shared.ApiBody "Success" @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internel Error" @Router /plugins/tapd/test [POST]

Types ¶

type CodeTransformationRules ¶ added in v0.14.0

type CodeTransformationRules struct {
	PrType               string `mapstructure:"prType" json:"prType"`
	PrComponent          string `mapstructure:"prComponent" json:"prComponent"`
	PrBodyClosePattern   string `mapstructure:"prBodyClosePattern" json:"prBodyClosePattern"`
	IssueSeverity        string `mapstructure:"issueSeverity" json:"issueSeverity"`
	IssuePriority        string `mapstructure:"issuePriority" json:"issuePriority"`
	IssueComponent       string `mapstructure:"issueComponent" json:"issueComponent"`
	IssueTypeBug         string `mapstructure:"issueTypeBug" json:"issueTypeBug"`
	IssueTypeIncident    string `mapstructure:"issueTypeIncident" json:"issueTypeIncident"`
	IssueTypeRequirement string `mapstructure:"issueTypeRequirement" json:"issueTypeRequirement"`
}

type TapdBlueprintSetting ¶ added in v0.14.0

type TapdBlueprintSetting []struct {
	Version     string `json:"version"`
	Connections []struct {
		Plugin       string `json:"plugin"`
		ConnectionID int    `json:"connectionId"`
		Scope        []struct {
			Options struct {
				WorkspaceId uint64   `mapstruct:"workspaceId"`
				CompanyId   uint64   `mapstruct:"companyId"`
				Tasks       []string `mapstruct:"tasks,omitempty"`
				Since       string
			} `json:"options"`
			Entities []string `json:"entities"`
		} `json:"scope"`
	} `json:"connections"`
}

type TapdPipelinePlan ¶ added in v0.14.0

type TapdPipelinePlan [][]struct {
	Plugin   string   `json:"plugin"`
	Subtasks []string `json:"subtasks"`
	Options  struct {
		WorkspaceId uint64   `mapstruct:"workspaceId"`
		CompanyId   uint64   `mapstruct:"companyId"`
		Tasks       []string `mapstruct:"tasks,omitempty"`
		Since       string
	} `json:"options"`
}

type TicketTransformationRules ¶ added in v0.14.0

type TicketTransformationRules struct {
	EpicKeyField               string `json:"epicKeyField"`
	StoryPointField            string `json:"storyPointField"`
	RemotelinkCommitShaPattern string `json:"remotelinkCommitShaPattern"`
	TypeMappings               map[string]struct {
		StandardType string `json:"standardType"`
	} `json:"typeMappings"`
}

Source Files ¶

View all Source files

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