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: 23 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DeleteConnection 

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

DeleteConnection delete an Azure DevOps connection @Summary delete an Azure DevOps connection @Description Delete an Azure DevOps connection @Tags plugins/azuredevops @Success 200 {object} models.AzuredevopsConnection @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/azuredevops/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/azuredevops @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 {object} models.AzuredevopsRepo @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 409 {object} srvhelper.DsRefs "References exist to this scope" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/azuredevops/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/azuredevops @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/azuredevops/connections/{connectionId}/scope-configs/{id} [DELETE]

func GetConnection 

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

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

func GetScope 

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

GetScope get one Azure DevOps repo @Summary get one Azure DevOps repo @Description get one Azure DevOps repo @Tags plugins/azuredevops @Param connectionId path int true "connection ID" @Param scopeId path int true "scope ID" @Param blueprints query bool false "also return blueprints using these scopes as part of the payload" @Success 200 {object} ScopeDetail @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/azuredevops/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/azuredevops @Param id path int true "id" @Param connectionId path int true "connectionId" @Success 200 {object} models.AzuredevopsScopeConfig @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/azuredevops/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/azuredevops @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.AzuredevopsScopeConfig @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/azuredevops/connections/{connectionId}/scope-configs [GET]

func GetScopes 

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

GetScopes get Azure DevOps repos @Summary get Azure DevOps repos @Description get Azure DevOps repos @Tags plugins/azuredevops @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} []ScopeDetail @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/azuredevops/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 get all Azure DevOps connections @Summary get all Azure DevOps connections @Description Get all Azure DevOps connections @Tags plugins/azuredevops @Success 200 {object} []models.AzuredevopsConnection @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /plugins/azuredevops/connections [GET]

func MakePipelinePlanV200 

func MakePipelinePlanV200(
	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 patch Azure DevOps connection @Summary patch Azure DevOps connection @Description Patch Azure DevOps connection @Tags plugins/azuredevops @Param body body models.AzuredevopsConnection true "json body" @Success 200 {object} models.AzuredevopsConnection @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /plugins/azuredevops/connections/{connectionId} [PATCH]

func PatchScope 

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

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

func PatchScopeConfig 

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

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

func PostConnections 

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

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

func PostScopeConfig 

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

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

func Proxy 

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

Proxy is a remote server API proxy @Summary Remote server API proxy @Description Forward API requests to the specified remote server @Param connectionId path int true "connection ID" @Param path path string true "path to an API endpoint" @Tags plugins/azuredevops @Router /plugins/azuredevops/connections/{connectionId}/proxy/{path} [GET]

func PutScopes 

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

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

func RemoteScopes 

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

RemoteScopes list all available scopes on the remote server @Summary list all available scopes on the remote server @Description list all available scopes on the remote 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" @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Success 200 {object} dsmodels.DsRemoteApiScopeList[models.AzuredevopsRepo] @Tags plugins/azuredevops @Router /plugins/azuredevops/connections/{connectionId}/remote-scopes [GET]

func SearchRemoteScopes 

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

SearchRemoteScopes searches scopes on the remote server @Summary searches scopes on the remote server @Description searches scopes on the remote 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" @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Success 200 {object} dsmodels.DsRemoteApiScopeList[models.AzuredevopsRepo] "the parentIds are always null" @Tags plugins/azuredevops @Router /plugins/azuredevops/connections/{connectionId}/search-remote-scopes [GET]

func TestConnection 

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

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

func TestExistingConnection 

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

TestExistingConnection test Azure DevOps connection @Summary test Azure DevOps connection @Description Test Azure DevOps Connection @Tags plugins/azuredevops @Success 200 {object} AzuredevopsTestConnResponse "Success" @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /plugins/azuredevops/connections/{connectionId}/test [POST]

Types

type Account 

type Account struct {
	AccountId        string      `json:"AccountId"`
	NamespaceId      string      `json:"NamespaceId"`
	AccountName      string      `json:"AccountName"`
	OrganizationName interface{} `json:"OrganizationName"`
	AccountType      int         `json:"AccountType"`
	AccountOwner     string      `json:"AccountOwner"`
	CreatedBy        string      `json:"CreatedBy"`
	CreatedDate      string      `json:"CreatedDate"`
	AccountStatus    int         `json:"AccountStatus"`
	StatusReason     interface{} `json:"StatusReason"`
	LastUpdatedBy    string      `json:"LastUpdatedBy"`
	Properties       struct {
	} `json:"Properties"`
}

type AccountResponse 

type AccountResponse []Account

type AzuredevopsApiRepo 

type AzuredevopsApiRepo struct {
	Id      string `json:"id"`
	Name    string `json:"name"`
	Url     string `json:"url"`
	Project struct {
		Id             string    `json:"id"`
		Name           string    `json:"name"`
		Description    string    `json:"description"`
		Url            string    `json:"url"`
		State          string    `json:"state"`
		Revision       int       `json:"revision"`
		Visibility     string    `json:"visibility"`
		LastUpdateTime time.Time `json:"lastUpdateTime"`
	} `json:"project"`
	DefaultBranch   string `json:"defaultBranch"`
	Size            int    `json:"size"`
	RemoteUrl       string `json:"remoteUrl"`
	SshUrl          string `json:"sshUrl"`
	WebUrl          string `json:"webUrl"`
	IsDisabled      bool   `json:"isDisabled"`
	IsInMaintenance bool   `json:"isInMaintenance"`
	IsFork          bool   `json:"isFork"`
}

type AzuredevopsRemotePagination 

type AzuredevopsRemotePagination struct {
	Skip int
	Top  int
}

type AzuredevopsTaskOptions 

type AzuredevopsTaskOptions tasks.AzuredevopsOptions

type AzuredevopsTestConnResponse 

type AzuredevopsTestConnResponse struct {
	shared.ApiBody
}

type Profile 

type Profile struct {
	DisplayName  string    `json:"displayName"`
	PublicAlias  string    `json:"publicAlias"`
	EmailAddress string    `json:"emailAddress"`
	CoreRevision int       `json:"coreRevision"`
	TimeStamp    time.Time `json:"timeStamp"`
	Id           string    `json:"id"`
	Revision     int       `json:"revision"`
}

type PutScopesReqBody 

type PutScopesReqBody api.PutScopesReqBody[models.AzuredevopsRepo]

type ScopeDetail 

type ScopeDetail api.ScopeDetail[models.AzuredevopsRepo, models.AzuredevopsScopeConfig]

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.