api

Documentation

Index

• func DeleteConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func GetConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func Init(config *viper.Viper, logger core.Logger, database *gorm.DB)
• func ListConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func MakePipelinePlan(subtaskMetas []core.SubTaskMeta, connectionId uint64, ...) (core.PipelinePlan, error)
• func PatchConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func PostConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)
• func TestConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

Functions

func DeleteConnection

func DeleteConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

DELETE /plugins/github/connections/:connectionId

func GetConnection

func GetConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

GET /plugins/github/connections/:connectionId

func Init

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

func ListConnections

func ListConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

GET /plugins/github/connections

func MakePipelinePlan

func MakePipelinePlan(subtaskMetas []core.SubTaskMeta, connectionId uint64, scope []*core.BlueprintScopeV100) (core.PipelinePlan, error)

func PatchConnection

func PatchConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

PATCH /plugins/github/connections/:connectionId

func PostConnections

func PostConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

POST /plugins/github/connections

func TestConnection

func TestConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error)

POST /plugins/github/test REQUEST BODY:

{
	"endpoint": "https://api.github.com/",
	"token": "github api access token"
}

RESPONSE BODY: Success:

{
	"login": "xxx"
}

Failure:

{
	"success": false,
	"message": "invalid token"
}