api

Documentation

Index

• func DeleteConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func GetConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func Init(br context.BasicRes, p plugin.PluginMeta)
• func ListConnections(_ *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func PatchConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func PostConnections(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• type FeishuBlueprintPlan
• type FeishuPipelinePlan
• type FeishuTestConnResponse

Functions

func DeleteConnection

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

@Summary delete a feishu connection @Description Delete a feishu connection @Tags plugins/feishu @Success 200 {object} models.FeishuConnection @Failure 400 {string} errcode.Error "Bad Request" @Failure 409 {object} services.BlueprintProjectPairs "References exist to this connection" @Failure 500 {string} errcode.Error "Internal Error" @Router /plugins/feishu/connections/{connectionId} [DELETE]

func GetConnection

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

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

func Init

func Init(br context.BasicRes, p plugin.PluginMeta)

func ListConnections

func ListConnections(_ *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)

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

func PatchConnection

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

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

func PostConnections

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

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

func TestConnection

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

@Summary test feishu connection @Description Test feishu Connection. endpoint: https://open.feishu.cn/open-apis/ @Tags plugins/feishu @Param body body models.FeishuConn true "json body" @Success 200 {object} FeishuTestConnResponse "Success" @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /plugins/feishu/test [POST]

Types

type FeishuBlueprintPlan

type FeishuBlueprintPlan [][]struct {
	Plugin  string   `json:"plugin"`
	Options struct{} `json:"options"`
}

type FeishuPipelinePlan

type FeishuPipelinePlan [][]struct {
	Plugin  string   `json:"plugin"`
	Options struct{} `json:"options"`
}

type FeishuTestConnResponse

type FeishuTestConnResponse struct {
	shared.ApiBody
	Connection *models.FeishuConn
}