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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ApplyRegex 

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

ApplyRegex return parsed commits URLs @Summary return parsed commits URLs @Description return parsed commits URLs @Tags plugins/jira @Param apply-regex body applyRegexReq true "apply regex" @Success 200 {object} []string @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/jira/apply-regex [POST]

func CreateScopeConfig 

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

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

func DeleteConnection 

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

@Summary delete a jira connection @Description Delete a Jira connection @Tags plugins/jira @Success 200 {object} models.JiraConnection @Failure 400 {string} errcode.Error "Bad Request" @Failure 409 {object} srvhelper.DsRefs "References exist to this connection" @Failure 500 {string} errcode.Error "Internal Error" @Router /plugins/jira/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/jira @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} srvhelper.DsRefs "References exist to this scope" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/jira/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/jira @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/jira/connections/{connectionId}/scope-configs/{id} [DELETE]

func GenRegex 

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

GenRegex generate regex from url @Summary generate regex from url @Description generate regex from url @Tags plugins/jira @Param generate-regex body genRegexReq true "generate regex" @Success 200 {object} genRegexResp @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/jira/generate-regex [POST]

func GetApiJira 

func GetApiJira(op *tasks.JiraOptions, apiClient plugin.ApiClient) (*apiv2models.Board, errors.Error)

func GetApplicationTypes 

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

GetApplicationTypes return issue application types @Summary return issue application types @Description return issue application types @Tags plugins/jira @Param connectionId path int true "connectionId" @Param key query string false "issue key" @Success 200 {object} []string @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/jira/connections/{connectionId}/application-types [GET]

func GetCommitsURLs 

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

GetCommitsURLs return some commits URLs @Summary return some commits URLs, at most 5 @Description return some commits URLs, at most 5 @Tags plugins/jira @Param connectionId path int true "connectionId" @Param key query string true "issue key" @Param applicationType query string true "application type" @Success 200 {object} []string @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/jira/connections/{connectionId}/dev-panel-commits [GET]

func GetConnection 

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

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

func GetScope 

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

GetScope get one Jira board @Summary get one Jira board @Description get one Jira board @Tags plugins/jira @Param connectionId path int false "connection ID" @Param scopeId path int false "board ID" @Success 200 {object} ScopeDetail @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/jira/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/jira @Param id path int true "id" @Param connectionId path int true "connectionId" @Success 200 {object} models.JiraScopeConfig @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/jira/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/jira @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.JiraScopeConfig @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/jira/connections/{connectionId}/scope-configs [GET]

func GetScopeLatestSyncState 

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

GetScopeLatestSyncState get one Jira board's latest sync state @Summary get one Jira board's latest sync state @Description get one Jira board's latest sync state @Tags plugins/jira @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/jira/connections/{connectionId}/scopes/{scopeId}/latest-sync-state [GET]

func GetScopeList 

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

GetScopeList get Jira boards @Summary get Jira boards @Description get Jira boards @Tags plugins/jira @Param connectionId path int false "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} []ScopeDetail @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/jira/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 jira connections @Description Get all Jira connections @Tags plugins/jira @Success 200 {object} []models.JiraConnection @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /plugins/jira/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 jira connection @Description Patch Jira connection @Tags plugins/jira @Param body body models.JiraConnection true "json body" @Success 200 {object} models.JiraConnection @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /plugins/jira/connections/{connectionId} [PATCH]

func PostConnections 

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

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

func Proxy 

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

@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 a API endpoint" @Router /plugins/jira/connections/{connectionId}/proxy/{path} [GET] @Tags plugins/jira

func PutScope 

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

PutScope create or update jira board @Summary create or update jira board @Description Create or update Jira board @Tags plugins/jira @Accept application/json @Param connectionId path int false "connection ID" @Param searchTerm query string false "search term for scope name" @Param scope body PutScopesReqBody true "json" @Success 200 {object} []models.JiraBoard @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/jira/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.JiraBoard] @Tags plugins/jira @Router /plugins/jira/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.JiraBoard] "the parentIds are always null" @Tags plugins/jira @Router /plugins/jira/connections/{connectionId}/search-remote-scopes [GET]

func TestConnection 

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

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

func TestExistingConnection 

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

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

func UpdateScope 

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

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

func UpdateScopeConfig 

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

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

Types

type JiraRemotePagination 

type JiraRemotePagination struct {
	MaxResults int `json:"maxResults"`
	StartAt    int `json:"startAt"`
}

type JiraTaskOptions 

type JiraTaskOptions tasks.JiraOptions

type JiraTestConnResponse 

type JiraTestConnResponse struct {
	shared.ApiBody
	Connection *models.JiraConn
}

type PutScopesReqBody 

type PutScopesReqBody api.PutScopesReqBody[models.JiraBoard]

type ScopeDetail 

type ScopeDetail api.ScopeDetail[models.JiraBoard, models.JiraScopeConfig]

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.