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 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, ...) (plugin.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 SearchRemoteScopes(input *plugin.ApiResourceInput) (*plugin.ApiResourceOutput, errors.Error)
• func TestConnection(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 BitBucketTestConnResponse
• type ScopeReq
• type ScopeRes

Functions

func CreateScopeConfig

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

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

func DeleteConnection

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

@Summary delete a bitbucket connection @Description Delete a bitbucket connection @Tags plugins/bitbucket @Success 200 {object} models.BitbucketConnection @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/bitbucket/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/bitbucket @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/bitbucket/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/bitbucket @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/bitbucket/connections/{connectionId}/scope-configs/{id} [DELETE]

func GetConnection

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

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

func GetScope

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

GetScope get one repo @Summary get one repo @Description get one repo @Tags plugins/bitbucket @Param connectionId path int true "connection ID" @Param scopeId path string true "repo ID" @Success 200 {object} ScopeRes @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/bitbucket/connections/{connectionId}/scopes/{scopeId} [GET]

func GetScopeConfig

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

GetScopeConfig return one scope config @Summary return one scope config @Description return one scope config @Tags plugins/bitbucket @Param id path int true "id" @Param connectionId path int true "connectionId" @Success 200 {object} models.BitbucketScopeConfig @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/bitbucket/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/bitbucket @Param connectionId path int true "connectionId" @Param pageSize query int false "page size, default 50" @Param page query int false "page size, default 1" @Success 200 {object} []models.BitbucketScopeConfig @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/bitbucket/connections/{connectionId}/scope-configs [GET]

func GetScopeList

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

GetScopeList get repos @Summary get repos @Description get repos @Tags plugins/bitbucket @Param connectionId path int true "connection ID" @Param pageSize query int false "page size, default 50" @Param page query int false "page size, default 1" @Param blueprints query bool false "also return blueprints using these scopes as part of the payload" @Success 200 {object} []ScopeRes @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/bitbucket/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)

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

func MakeDataSourcePipelinePlanV200

func MakeDataSourcePipelinePlanV200(subtaskMetas []plugin.SubTaskMeta, connectionId uint64, bpScopes []*plugin.BlueprintScopeV200, syncPolicy *plugin.BlueprintSyncPolicy) (plugin.PipelinePlan, []plugin.Scope, errors.Error)

func PatchConnection

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

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

func PostConnections

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

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

func PutScope

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

PutScope create or update repo @Summary create or update repo @Description Create or update repo @Tags plugins/bitbucket @Accept application/json @Param connectionId path int true "connection ID" @Param scope body ScopeReq true "json" @Success 200 {object} []models.BitbucketRepo @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/bitbucket/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/bitbucket @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/bitbucket/connections/{connectionId}/remote-scopes [GET]

func SearchRemoteScopes

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

SearchRemoteScopes use the Search API and only return project @Summary use the Search API and only return project @Description use the Search API and only return project @Tags plugins/bitbucket @Accept application/json @Param connectionId path int false "connection ID" @Param search query string false "search" @Param page query int false "page number" @Param pageSize query int false "page size per page" @Success 200 {object} api.SearchRemoteScopesOutput @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/bitbucket/connections/{connectionId}/search-remote-scopes [GET]

func TestConnection

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

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

func UpdateScope

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

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

func UpdateScopeConfig

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

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

Types

type BitBucketTestConnResponse

type BitBucketTestConnResponse struct {
	shared.ApiBody
	Connection *models.BitbucketConn
}

type ScopeReq

type ScopeReq api.ScopeReq[models.BitbucketRepo]

type ScopeRes

type ScopeRes struct {
	models.BitbucketRepo
	api.ScopeResDoc[models.BitbucketScopeConfig]
}