api

Documentation

Index

• func CreateScopeConfig(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func DeleteConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func DeleteScope(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func DeleteScopeConfig(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func GetConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func GetScope(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func GetScopeConfig(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func GetScopeConfigList(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func GetScopeLatestSyncState(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func GetScopeList(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func Init(br context.BasicRes, p plugin.PluginMeta)
• func ListConnections(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func MakeDataSourcePipelinePlanV200(subtaskMetas []plugin.SubTaskMeta, connectionId uint64, ...) (coreModels.PipelinePlan, []plugin.Scope, errors.Error)
• func PatchConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func PostConnections(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func PutScope(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func RemoteScopes(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func TestConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func TestExistingConnection(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func UpdateScope(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func UpdateScopeConfig(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• type CircleciTestConnResponse
• type RemoteProject
  • func (c RemoteProject) ConvertApiScope() plugin.ToolLayerScope

Functions

func CreateScopeConfig

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

CreateScopeConfig create scope config for Bamboo @Summary create scope config for Bamboo @Description create scope config for Bamboo @Tags plugins/bamboo @Accept application/json @Param connectionId path int true "connectionId" @Param scopeConfig body models.BambooScopeConfig true "scope config" @Success 200 {object} models.BambooScopeConfig @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/bamboo/connections/{connectionId}/scope-configs [POST]

func DeleteConnection

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

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

func DeleteScope

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

DeleteScope delete plugin data associated with the scope and optionally the scope itself @Summary delete plugin data associated with the scope and optionally the scope itself @Description delete data associated with plugin scope @Tags plugins/circleci @Param connectionId path int true "connection ID" @Param scopeId path int true "scope ID" @Param delete_data_only query bool false "Only delete the scope data, not the scope itself" @Success 200 @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 409 {object} api.ScopeRefDoc "References exist to this scope" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/circleci/connections/{connectionId}/scopes/{scopeId} [DELETE]

func DeleteScopeConfig

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

DeleteScopeConfig delete a scope config @Summary delete a scope config @Description delete a scope config @Tags plugins/bamboo @Param id path int true "id" @Param connectionId path int true "connectionId" @Success 200 @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/bamboo/connections/{connectionId}/scope-configs/{id} [DELETE]

func GetConnection

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

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

func GetScope

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

GetScope get one Circleci pipeline @Summary get one Circleci pipeline @Description get one Circleci pipeline @Tags plugins/circleci @Param connectionId path int true "connection ID" @Param scopeId path int true "pipeline id" @Param pageSize query int false "page size, default 50" @Param page query int false "page size, default 1" @Success 200 {object} models.CircleciPipeline @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/circleci/connections/{connectionId}/scopes/{scopeId} [GET]

func GetScopeConfig

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

GetScopeConfig return onescope config @Summary return onescope config @Description return onescope config @Tags plugins/bamboo @Param id path int true "id" @Param connectionId path int true "connectionId" @Success 200 {object} models.BambooScopeConfig @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/bamboo/connections/{connectionId}/scope-configs/{id} [GET]

func GetScopeConfigList

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

GetScopeConfigList return all scope configs @Summary return all scope configs @Description return all scope configs @Tags plugins/bamboo @Param pageSize query int false "page size, default 50" @Param page query int false "page size, default 1" @Param connectionId path int true "connectionId" @Success 200 {object} []models.BambooScopeConfig @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/bamboo/connections/{connectionId}/scope-configs [GET]

func GetScopeLatestSyncState

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

GetScopeLatestSyncState get one CircleCI pipeline's latest sync state @Summary get one CircleCI pipeline's latest sync state @Description get one CircleCI pipeline's latest sync state @Tags plugins/circleci @Param connectionId path int true "connection ID" @Param scopeId path int true "scope ID" @Success 200 {object} []models.LatestSyncState @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/circleci/connections/{connectionId}/scopes/{scopeId}/latest-sync-state [GET]

func GetScopeList

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

GetScopeList get Circleci pipelines @Summary get Circleci pipelines @Description get Circleci pipelines @Tags plugins/circleci @Param connectionId path int true "connection ID" @Param searchTerm query string false "search term for scope name" @Param blueprints query bool false "also return blueprints using these scopes as part of the payload" @Success 200 {object} []models.CircleciPipeline @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/circleci/connections/{connectionId}/scopes/ [GET]

func Init

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

func ListConnections

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

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

func MakeDataSourcePipelinePlanV200

func MakeDataSourcePipelinePlanV200(
	subtaskMetas []plugin.SubTaskMeta,
	connectionId uint64,
	bpScopes []*coreModels.BlueprintScope,
) (coreModels.PipelinePlan, []plugin.Scope, errors.Error)

func PatchConnection

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

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

func PostConnections

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

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

func PutScope

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

PutScope create or update circleci pipeline @Summary create or update circleci pipeline @Description Create or update circleci pipeline @Tags plugins/circleci @Accept application/json @Param connectionId path int true "connection ID" @Param scope body scopeReq true "json" @Success 200 {object} models.CircleciPipeline @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/circleci/connections/{connectionId}/scopes [PUT]

func RemoteScopes

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

RemoteScopes list all available scope for users @Summary list all available scope for users @Description list all available scope for users @Tags plugins/circleci @Accept application/json @Param connectionId path int false "connection ID" @Param groupId query string false "group ID" @Param pageToken query string false "page Token" @Success 200 {object} api.RemoteScopesOutput @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/circleci/connections/{connectionId}/remote-scopes [GET]

func TestConnection

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

TestConnection test circleci connection @Summary test circleci connection @Description Test circleci Connection @Tags plugins/circleci @Param body body models.CircleciConnection true "json body" @Success 200 {object} CircleciTestConnResponse "Success" @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /plugins/circleci/test [POST]

func TestExistingConnection

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

TestExistingConnection test circleci connection @Summary test circleci connection @Description Test circleci Connection @Tags plugins/circleci @Param connectionId path int true "connection ID" @Success 200 {object} CircleciTestConnResponse "Success" @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /plugins/circleci/connections/{connectionId}/test [POST]

func UpdateScope

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

UpdateScope patch to circleci pipeline @Summary patch to circleci pipeline @Description patch to circleci pipeline @Tags plugins/circleci @Accept application/json @Param connectionId path int true "connection ID" @Param scopeId path int true "pipeline id" @Param scope body models.CircleciPipeline true "json" @Success 200 {object} models.CircleciPipeline @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/circleci/connections/{connectionId}/scopes/{scopeId} [PATCH]

func UpdateScopeConfig

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

UpdateScopeConfig update scope config for Bamboo @Summary update scope config for Bamboo @Description update scope config for Bamboo @Tags plugins/bamboo @Accept application/json @Param id path int true "id" @Param scopeConfig body models.BambooScopeConfig true "scope config" @Param connectionId path int true "connectionId" @Success 200 {object} models.BambooScopeConfig @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/bamboo/connections/{connectionId}/scope-configs/{id} [PATCH]

Types

type CircleciTestConnResponse

type CircleciTestConnResponse struct {
	shared.ApiBody
}

type RemoteProject

type RemoteProject struct {
	Id    string `json:"id"`
	Name  string `json:"name"`
	OrgId string `json:"org_id"`
	Slug  string `json:"slug"`
}

func (RemoteProject) ConvertApiScope

func (c RemoteProject) ConvertApiScope() plugin.ToolLayerScope

ConvertApiScope implements plugin.ApiScope.