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: 21 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 Jenkins @Summary create scope config for Jenkins @Description create scope config for Jenkins @Tags plugins/jenkins @Accept application/json @Param connectionId path int true "connectionId" @Param scopeConfig body models.JenkinsScopeConfig true "scope config" @Success 200 {object} models.JenkinsScopeConfig @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/jenkins/connections/{connectionId}/scope-configs [POST]

func DeleteConnection 

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

@Summary delete a jenkins connection @Description Delete a Jenkins connection @Tags plugins/jenkins @Success 200 {object} models.JenkinsConnection @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/jenkins/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/jenkins @Param connectionId path int true "connection ID" @Param scopeId path string 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/jenkins/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/jenkins @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/jenkins/connections/{connectionId}/scope-configs/{id} [DELETE]

func GetAllJobs 

func GetAllJobs(
	apiClient plugin.ApiClient,
	path string,
	beforename string,
	pageSize int,
	callback func(job *models.Job, isPath bool) errors.Error,
) errors.Error

request all jobs

func GetConnection 

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

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

func GetJob 

func GetJob(
	apiClient plugin.ApiClient,
	path string,
	name string,
	fullName string,
	pageSize int,
	callback func(job *models.Job, isPath bool) errors.Error,
) errors.Error

func GetJobs 

func GetJobs(apiClient plugin.ApiClient, path string, pageSize int, callback func(job *models.Job) errors.Error) errors.Error

func GetJobsPage 

func GetJobsPage(apiClient plugin.ApiClient, path string, page int, pageSize int, callback func(job *models.Job) errors.Error) (int, errors.Error)

func GetScope 

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

GetScope get one Jenkins job @Summary get one Jenkins job @Description get one Jenkins job @Tags plugins/jenkins @Param connectionId path int false "connection ID" @Param scopeId path string false "job's full name" @Success 200 {object} ScopeRes @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/jenkins/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/jenkins @Param id path int true "id" @Param connectionId path int true "connectionId" @Success 200 {object} models.JenkinsScopeConfig @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/jenkins/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/jenkins @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.JenkinsScopeConfig @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/jenkins/connections/{connectionId}/scope-configs [GET]

func GetScopeDispatcher 

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

func GetScopeLatestSyncState 

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

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

func GetScopeList 

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

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

func PatchScope 

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

PatchScope patch to jenkins job @Summary patch to jenkins job @Description patch to jenkins job @Tags plugins/jenkins @Accept application/json @Param connectionId path int false "connection ID" @Param scopeId path string false "job's full name" @Param scope body models.JenkinsJob true "json" @Success 200 {object} models.JenkinsJob @Failure 400 {object} shared.ApiBody "Bad Request" @Failure 500 {object} shared.ApiBody "Internal Error" @Router /plugins/jenkins/connections/{connectionId}/scopes/{scopeId} [PATCH]

func PostConnections 

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

@Summary create jenkins connection @Description Create Jenkins connection @Tags plugins/jenkins @Param body body models.JenkinsConnection true "json body" @Success 200 {object} models.JenkinsConnection @Failure 400 {string} errcode.Error "Bad Request" @Failure 500 {string} errcode.Error "Internal Error" @Router /plugins/jenkins/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/jenkins/connections/{connectionId}/proxy/{path} [GET] @Tags plugins/jenkins

func PutScope 

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

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

func TestConnection 

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

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

func TestExistingConnection 

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

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

func UpdateScopeConfig 

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

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

Types

type JenkinsRemotePagination 

type JenkinsRemotePagination struct {
	Page    int `json:"page"`
	PerPage int `json:"per_page"`
}

type JenkinsTaskOptions 

type JenkinsTaskOptions tasks.JenkinsOptions

type JenkinsTestConnResponse 

type JenkinsTestConnResponse struct {
	shared.ApiBody
	Connection *models.JenkinsConn
}

type ScopeReq 

type ScopeReq api.ScopeReq[models.JenkinsJob]

type ScopeRes 

type ScopeRes struct {
	models.JenkinsJob
	api.ScopeResDoc[models.JenkinsScopeConfig]
}

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.