api

package
v0.0.0-...-1fa52ee Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 3, 2024 License: Apache-2.0, BSD-2-Clause, ISC, + 1 more Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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_server @Accept application/json @Param connectionId path int true "connectionId" @Param scopeConfig body models.BitbucketServerScopeConfig true "scope config" @Success 200 {object} models.BitbucketServerScopeConfig @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/bitbucket_server/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_server @Success 200 {object} models.BitbucketServerConnection @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_server/connections/{connectionId} [DELETE]

func DeleteScope

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_server @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_server/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_server @Param scopeConfigId path int true "scopeConfigId" @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_server/connections/{connectionId}/scope-configs/{scopeConfigId} [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_server @Success 200 {object} models.BitbucketServerConnection @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /plugins/bitbucket_server/connections/{connectionId} [GET]

func GetScope

GetScope get one repo @Summary get one repo @Description get one repo @Tags plugins/bitbucket_server @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_server/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_server @Param scopeConfigId path int true "scopeConfigId" @Param connectionId path int true "connectionId" @Success 200 {object} models.BitbucketServerScopeConfig @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/bitbucket_server/connections/{connectionId}/scope-configs/{scopeConfigId} [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_server @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.BitbucketServerScopeConfig @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/bitbucket_server/connections/{connectionId}/scope-configs [GET]

func GetScopeLatestSyncState

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

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

func GetScopeList

GetScopeList get repos @Summary get repos @Description get repos @Tags plugins/bitbucket_server @Param connectionId path int true "connection ID" @Param searchTerm query string false "search term for scope name" @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_server/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_server @Success 200 {object} []models.BitbucketServerConnection @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /plugins/bitbucket_server/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)

@Summary patch bitbucket connection @Description Patch bitbucket connection @Tags plugins/bitbucket_server @Param body body models.BitbucketServerConnection true "json body" @Success 200 {object} models.BitbucketServerConnection @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /plugins/bitbucket_server/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_server @Param body body models.BitbucketServerConnection true "json body" @Success 200 {object} models.BitbucketServerConnection @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /plugins/bitbucket_server/connections [POST]

func PutScope

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

func RemoteScopes

RemoteScopes list all available scope for users @Summary list all available scope for users @Description list all available scope for users @Tags plugins/bitbucket_server @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_server/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_server @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_server/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_server @Param body body models.BitbucketServerConn true "json body" @Success 200 {object} BitBucketServerTestConnResponse "Success" @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /plugins/bitbucket_server/test [POST]

func TestExistingConnection

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

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

func UpdateScope

UpdateScope patch to repo @Summary patch to repo @Description patch to repo @Tags plugins/bitbucket_server @Accept application/json @Param connectionId path int true "connection ID" @Param scopeId path string true "repo ID" @Param scope body models.BitbucketServerRepo true "json" @Success 200 {object} models.BitbucketServerRepo @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/bitbucket_server/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_server @Accept application/json @Param scopeConfigId path int true "scopeConfigId" @Param connectionId path int true "connectionId" @Param scopeConfig body models.BitbucketServerScopeConfig true "scope config" @Success 200 {object} models.BitbucketServerScopeConfig @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/bitbucket_server/connections/{connectionId}/scope-configs/{scopeConfigId} [PATCH]

Types

type BitBucketServerRemotePagination

type BitBucketServerRemotePagination struct {
	Start int `json:"start"`
	Limit int `json:"limit"`
}

type BitBucketServerTestConnResponse

type BitBucketServerTestConnResponse struct {
	shared.ApiBody
	Connection *models.BitbucketServerConn
}

Jump to

Keyboard shortcuts

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