Documentation
¶
Index ¶
- func BlockTilQueueHasRunningItem(c *gin.Context)
- func CancelPipeline(c *gin.Context)
- func ChownRepo(c *gin.Context)
- func CreatePipeline(c *gin.Context)
- func DeleteAgent(c *gin.Context)
- func DeleteCron(c *gin.Context)
- func DeleteForge(c *gin.Context)
- func DeleteGlobalRegistry(c *gin.Context)
- func DeleteGlobalSecret(c *gin.Context)
- func DeleteOrg(c *gin.Context)
- func DeleteOrgAgent(c *gin.Context)
- func DeleteOrgRegistry(c *gin.Context)
- func DeleteOrgSecret(c *gin.Context)
- func DeletePipeline(c *gin.Context)
- func DeletePipelineLogs(c *gin.Context)
- func DeleteRegistry(c *gin.Context)
- func DeleteRepo(c *gin.Context)
- func DeleteSecret(c *gin.Context)
- func DeleteStepLogs(c *gin.Context)
- func DeleteToken(c *gin.Context)
- func DeleteUser(c *gin.Context)
- func EventStreamSSE(c *gin.Context)
- func GetAgent(c *gin.Context)
- func GetAgentTasks(c *gin.Context)
- func GetAgents(c *gin.Context)
- func GetAllRepos(c *gin.Context)
- func GetBadge(c *gin.Context)
- func GetCC(c *gin.Context)
- func GetCron(c *gin.Context)
- func GetCronList(c *gin.Context)
- func GetFeed(c *gin.Context)
- func GetForge(c *gin.Context)
- func GetForges(c *gin.Context)
- func GetGlobalRegistry(c *gin.Context)
- func GetGlobalRegistryList(c *gin.Context)
- func GetGlobalSecret(c *gin.Context)
- func GetGlobalSecretList(c *gin.Context)
- func GetLogout(c *gin.Context)
- func GetOrg(c *gin.Context)
- func GetOrgAgents(c *gin.Context)
- func GetOrgPermissions(c *gin.Context)
- func GetOrgRegistry(c *gin.Context)
- func GetOrgRegistryList(c *gin.Context)
- func GetOrgSecret(c *gin.Context)
- func GetOrgSecretList(c *gin.Context)
- func GetOrgs(c *gin.Context)
- func GetPipeline(c *gin.Context)
- func GetPipelineConfig(c *gin.Context)
- func GetPipelineLast(c *gin.Context)
- func GetPipelineMetadata(c *gin.Context)
- func GetPipelineQueue(c *gin.Context)
- func GetPipelines(c *gin.Context)
- func GetQueueInfo(c *gin.Context)
- func GetRegistry(c *gin.Context)
- func GetRegistryList(c *gin.Context)
- func GetRepo(c *gin.Context)
- func GetRepoBranches(c *gin.Context)
- func GetRepoPermissions(c *gin.Context)
- func GetRepoPullRequests(c *gin.Context)
- func GetRepos(c *gin.Context)
- func GetSecret(c *gin.Context)
- func GetSecretList(c *gin.Context)
- func GetSelf(c *gin.Context)
- func GetSignaturePublicKey(c *gin.Context)
- func GetStepLogs(c *gin.Context)
- func GetUser(c *gin.Context)
- func GetUsers(c *gin.Context)
- func HandleAuth(c *gin.Context)
- func Health(c *gin.Context)
- func LogLevel(c *gin.Context)
- func LogStreamSSE(c *gin.Context)
- func LookupOrg(c *gin.Context)
- func LookupRepo(c *gin.Context)
- func MoveRepo(c *gin.Context)
- func PatchAgent(c *gin.Context)
- func PatchCron(c *gin.Context)
- func PatchForge(c *gin.Context)
- func PatchGlobalRegistry(c *gin.Context)
- func PatchGlobalSecret(c *gin.Context)
- func PatchOrgAgent(c *gin.Context)
- func PatchOrgRegistry(c *gin.Context)
- func PatchOrgSecret(c *gin.Context)
- func PatchRegistry(c *gin.Context)
- func PatchRepo(c *gin.Context)
- func PatchSecret(c *gin.Context)
- func PatchUser(c *gin.Context)
- func PauseQueue(c *gin.Context)
- func PostAgent(c *gin.Context)
- func PostApproval(c *gin.Context)
- func PostCron(c *gin.Context)
- func PostDecline(c *gin.Context)
- func PostForge(c *gin.Context)
- func PostGlobalRegistry(c *gin.Context)
- func PostGlobalSecret(c *gin.Context)
- func PostHook(c *gin.Context)
- func PostOrgAgent(c *gin.Context)
- func PostOrgRegistry(c *gin.Context)
- func PostOrgSecret(c *gin.Context)
- func PostPipeline(c *gin.Context)
- func PostRegistry(c *gin.Context)
- func PostRepo(c *gin.Context)
- func PostSecret(c *gin.Context)
- func PostToken(c *gin.Context)
- func PostUser(c *gin.Context)
- func RepairAllRepos(c *gin.Context)
- func RepairRepo(c *gin.Context)
- func ResumeQueue(c *gin.Context)
- func RunCron(c *gin.Context)
- func SetLogLevel(c *gin.Context)
- func Version(c *gin.Context)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BlockTilQueueHasRunningItem ¶
BlockTilQueueHasRunningItem
@Summary Block til pipeline queue has a running item @Router /queue/norunningpipelines [get] @Produce plain @Success 204 @Tags Pipeline queues @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
func CancelPipeline ¶
CancelPipeline
@Summary Cancel a pipeline
@Router /repos/{repo_id}/pipelines/{number}/cancel [post]
@Produce plain
@Success 200
@Tags Pipelines
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param number path int true "the number of the pipeline"
func ChownRepo ¶
ChownRepo
@Summary Change a repository's owner to the currently authenticated user
@Router /repos/{repo_id}/chown [post]
@Produce json
@Success 200 {object} Repo
@Tags Repositories
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
func CreatePipeline ¶
CreatePipeline
@Summary Trigger a manual pipeline
@Router /repos/{repo_id}/pipelines [post]
@Produce json
@Success 200 {object} Pipeline
@Tags Pipelines
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param options body PipelineOptions true "the options for the pipeline to run"
func DeleteAgent ¶
DeleteAgent
@Summary Delete an agent
@Router /agents/{agent_id} [delete]
@Produce plain
@Success 200
@Tags Agents
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param agent_id path int true "the agent's id"
func DeleteCron ¶
DeleteCron
@Summary Delete a cron job
@Router /repos/{repo_id}/cron/{cron} [delete]
@Produce plain
@Success 204
@Tags Repository cron jobs
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param cron path string true "the cron job id"
func DeleteForge ¶
DeleteForge
@Summary Delete a forge
@Router /forges/{forgeId} [delete]
@Produce plain
@Success 200
@Tags Forges
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param forgeId path int true "the forge's id"
func DeleteGlobalRegistry ¶
DeleteGlobalRegistry
@Summary Delete a global registry by name
@Router /registries/{registry} [delete]
@Produce plain
@Success 204
@Tags Registries
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param registry path string true "the registry's name"
func DeleteGlobalSecret ¶
DeleteGlobalSecret
@Summary Delete a global secret by name
@Router /secrets/{secret} [delete]
@Produce plain
@Success 204
@Tags Secrets
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param secret path string true "the secret's name"
func DeleteOrg ¶
DeleteOrg
@Summary Delete an organization
@Description Deletes the given org. Requires admin rights.
@Router /orgs/{id} [delete]
@Produce plain
@Success 204
@Tags Orgs
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param id path string true "the org's id"
func DeleteOrgAgent ¶
DeleteOrgAgent
@Summary Delete an organization-scoped agent
@Router /orgs/{org_id}/agents/{agent_id} [delete]
@Produce plain
@Success 204
@Tags Agents
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param org_id path int true "the organization's id"
@Param agent_id path int true "the agent's id"
func DeleteOrgRegistry ¶
DeleteOrgRegistry
@Summary Delete an organization registry by name
@Router /orgs/{org_id}/registries/{registry} [delete]
@Produce plain
@Success 204
@Tags Organization registries
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param org_id path string true "the org's id"
@Param registry path string true "the registry's name"
func DeleteOrgSecret ¶
DeleteOrgSecret
@Summary Delete an organization secret by name
@Router /orgs/{org_id}/secrets/{secret} [delete]
@Produce plain
@Success 204
@Tags Organization secrets
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param org_id path string true "the org's id"
@Param secret path string true "the secret's name"
func DeletePipeline ¶
DeletePipeline
@Summary Delete a pipeline
@Router /repos/{repo_id}/pipelines/{number} [delete]
@Produce plain
@Success 204
@Tags Pipelines
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param number path int true "the number of the pipeline"
func DeletePipelineLogs ¶
DeletePipelineLogs
@Summary Deletes all logs of a pipeline
@Router /repos/{repo_id}/logs/{number} [delete]
@Produce plain
@Success 204
@Tags Pipeline logs
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param number path int true "the number of the pipeline"
func DeleteRegistry ¶
DeleteRegistry
@Summary Delete a registry by name
@Router /repos/{repo_id}/registries/{registry} [delete]
@Produce plain
@Success 204
@Tags Repository registries
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param registry path string true "the registry name"
func DeleteRepo ¶
DeleteRepo
@Summary Delete a repository
@Router /repos/{repo_id} [delete]
@Produce json
@Success 200 {object} Repo
@Tags Repositories
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
func DeleteSecret ¶
DeleteSecret
@Summary Delete a repository secret by name
@Router /repos/{repo_id}/secrets/{secretName} [delete]
@Produce plain
@Success 204
@Tags Repository secrets
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param secretName path string true "the secret name"
func DeleteStepLogs ¶
DeleteStepLogs
@Summary Delete step logs of a pipeline
@Router /repos/{repo_id}/logs/{number}/{stepId} [delete]
@Produce plain
@Success 204
@Tags Pipeline logs
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param number path int true "the number of the pipeline"
@Param stepId path int true "the step id"
func DeleteToken ¶
DeleteToken
@Summary Reset a token @Description Reset's the current personal access token of the user and returns a new one. @Router /user/token [delete] @Produce plain @Success 200 @Tags User @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
func DeleteUser ¶
DeleteUser
@Summary Delete a user
@Description Deletes the given user. Requires admin rights.
@Router /users/{login} [delete]
@Produce plain
@Success 204
@Tags Users
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param login path string true "the user's login name"
func EventStreamSSE ¶
EventStreamSSE
@Summary Stream events like pipeline updates @Description With quic and http2 support @Router /stream/events [get] @Produce plain @Success 200 @Tags Events
func GetAgent ¶
GetAgent
@Summary Get an agent
@Router /agents/{agent_id} [get]
@Produce json
@Success 200 {object} Agent
@Tags Agents
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param agent_id path int true "the agent's id"
func GetAgentTasks ¶
GetAgentTasks
@Summary List agent tasks
@Router /agents/{agent_id}/tasks [get]
@Produce json
@Success 200 {array} Task
@Tags Agents
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param agent_id path int true "the agent's id"
func GetAgents ¶
GetAgents
@Summary List agents
@Router /agents [get]
@Produce json
@Success 200 {array} Agent
@Tags Agents
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param page query int false "for response pagination, page offset number" default(1)
@Param perPage query int false "for response pagination, max items per page" default(50)
func GetAllRepos ¶
GetAllRepos
@Summary List all repositories on the server
@Description Returns a list of all repositories. Requires admin rights.
@Router /repos [get]
@Produce json
@Success 200 {array} Repo
@Tags Repositories
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param active query bool false "only list active repos"
@Param page query int false "for response pagination, page offset number" default(1)
@Param perPage query int false "for response pagination, max items per page" default(50)
func GetBadge ¶
GetBadge
@Summary Get status of pipeline as SVG badge
@Router /badges/{repo_id}/status.svg [get]
@Produce image/svg+xml
@Success 200
@Tags Badges
@Param repo_id path int true "the repository id"
func GetCC ¶
GetCC
@Summary Provide pipeline status information to the CCMenu tool
@Description CCMenu displays the pipeline status of projects on a CI server as an item in the Mac's menu bar.
@Description More details on how to install, you can find at http://ccmenu.org/
@Description The response format adheres to CCTray v1 Specification, https://cctray.org/v1/
@Router /badges/{repo_id}/cc.xml [get]
@Produce xml
@Success 200
@Tags Badges
@Param repo_id path int true "the repository id"
func GetCron ¶
GetCron
@Summary Get a cron job
@Router /repos/{repo_id}/cron/{cron} [get]
@Produce json
@Success 200 {object} Cron
@Tags Repository cron jobs
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param cron path string true "the cron job id"
func GetCronList ¶
GetCronList
@Summary List cron jobs
@Router /repos/{repo_id}/cron [get]
@Produce json
@Success 200 {array} Cron
@Tags Repository cron jobs
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param page query int false "for response pagination, page offset number" default(1)
@Param perPage query int false "for response pagination, max items per page" default(50)
func GetFeed ¶
GetFeed
@Summary Get the currently authenticated users pipeline feed
@Description The feed lists the most recent pipeline for the currently authenticated user.
@Router /user/feed [get]
@Produce json
@Success 200 {array} Feed
@Tags User
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
func GetForge ¶
GetForge
@Summary Get a forge
@Router /forges/{forgeId} [get]
@Produce json
@Success 200 {object} Forge
@Tags Forges
@Param Authorization header string false "Insert your personal access token" default(Bearer <personal access token>)
@Param forgeId path int true "the forge's id"
func GetForges ¶
GetForges
@Summary List forges
@Router /forges [get]
@Produce json
@Success 200 {array} Forge
@Tags Forges
@Param Authorization header string false "Insert your personal access token" default(Bearer <personal access token>)
@Param page query int false "for response pagination, page offset number" default(1)
@Param perPage query int false "for response pagination, max items per page" default(50)
func GetGlobalRegistry ¶
GetGlobalRegistry
@Summary Get a global registry by name
@Router /registries/{registry} [get]
@Produce json
@Success 200 {object} Registry
@Tags Registries
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param registry path string true "the registry's name"
func GetGlobalRegistryList ¶
GetGlobalRegistryList
@Summary List global registries
@Router /registries [get]
@Produce json
@Success 200 {array} Registry
@Tags Registries
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param page query int false "for response pagination, page offset number" default(1)
@Param perPage query int false "for response pagination, max items per page" default(50)
func GetGlobalSecret ¶
GetGlobalSecret
@Summary Get a global secret by name
@Router /secrets/{secret} [get]
@Produce json
@Success 200 {object} Secret
@Tags Secrets
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param secret path string true "the secret's name"
func GetGlobalSecretList ¶
GetGlobalSecretList
@Summary List global secrets
@Router /secrets [get]
@Produce json
@Success 200 {array} Secret
@Tags Secrets
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param page query int false "for response pagination, page offset number" default(1)
@Param perPage query int false "for response pagination, max items per page" default(50)
func GetOrg ¶
GetOrg
@Summary Get an organization
@Router /orgs/{org_id} [get]
@Produce json
@Success 200 {array} Org
@Tags Organization
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param org_id path string true "the organization's id"
func GetOrgAgents ¶
GetOrgAgents
@Summary List agents for an organization
@Router /orgs/{org_id}/agents [get]
@Produce json
@Success 200 {array} Agent
@Tags Agents
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param org_id path int true "the organization's id"
@Param page query int false "for response pagination, page offset number" default(1)
@Param perPage query int false "for response pagination, max items per page" default(50)
func GetOrgPermissions ¶
GetOrgPermissions
@Summary Get the permissions of the currently authenticated user for the given organization
@Router /orgs/{org_id}/permissions [get]
@Produce json
@Success 200 {array} OrgPerm
@Tags Organization permissions
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param org_id path string true "the organization's id"
func GetOrgRegistry ¶
GetOrgRegistry
@Summary Get a organization registry by address
@Router /orgs/{org_id}/registries/{registry} [get]
@Produce json
@Success 200 {object} Registry
@Tags Organization registries
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param org_id path string true "the org's id"
@Param registry path string true "the registry's address"
func GetOrgRegistryList ¶
GetOrgRegistryList
@Summary List organization registries
@Router /orgs/{org_id}/registries [get]
@Produce json
@Success 200 {array} Registry
@Tags Organization registries
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param org_id path string true "the org's id"
@Param page query int false "for response pagination, page offset number" default(1)
@Param perPage query int false "for response pagination, max items per page" default(50)
func GetOrgSecret ¶
GetOrgSecret
@Summary Get a organization secret by name
@Router /orgs/{org_id}/secrets/{secret} [get]
@Produce json
@Success 200 {object} Secret
@Tags Organization secrets
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param org_id path string true "the org's id"
@Param secret path string true "the secret's name"
func GetOrgSecretList ¶
GetOrgSecretList
@Summary List organization secrets
@Router /orgs/{org_id}/secrets [get]
@Produce json
@Success 200 {array} Secret
@Tags Organization secrets
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param org_id path string true "the org's id"
@Param page query int false "for response pagination, page offset number" default(1)
@Param perPage query int false "for response pagination, max items per page" default(50)
func GetOrgs ¶
GetOrgs
@Summary List organizations
@Description Returns all registered orgs in the system. Requires admin rights.
@Router /orgs [get]
@Produce json
@Success 200 {array} Org
@Tags Orgs
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param page query int false "for response pagination, page offset number" default(1)
@Param perPage query int false "for response pagination, max items per page" default(50)
func GetPipeline ¶
GetPipeline
@Summary Get a repositories pipeline
@Router /repos/{repo_id}/pipelines/{number} [get]
@Produce json
@Success 200 {object} Pipeline
@Tags Pipelines
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param number path int true "the number of the pipeline, OR 'latest'"
func GetPipelineConfig ¶
GetPipelineConfig
@Summary Get configuration files for a pipeline
@Router /repos/{repo_id}/pipelines/{number}/config [get]
@Produce json
@Success 200 {array} Config
@Tags Pipelines
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param number path int true "the number of the pipeline"
func GetPipelineLast ¶
func GetPipelineMetadata ¶
GetPipelineMetadata
@Summary Get metadata for a pipeline or a specific workflow, including previous pipeline info
@Router /repos/{repo_id}/pipelines/{number}/metadata [get]
@Produce json
@Success 200 {object} metadata.Metadata
@Tags Pipelines
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param number path int true "the number of the pipeline"
func GetPipelineQueue ¶
GetPipelineQueue
@Summary List pipelines in queue
@Router /pipelines [get]
@Produce json
@Success 200 {array} Feed
@Tags Pipeline queues
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
func GetPipelines ¶
GetPipelines
@Summary List repository pipelines
@Description Get a list of pipelines for a repository.
@Router /repos/{repo_id}/pipelines [get]
@Produce json
@Success 200 {array} Pipeline
@Tags Pipelines
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param page query int false "for response pagination, page offset number" default(1)
@Param perPage query int false "for response pagination, max items per page" default(50)
@Param before query string false "only return pipelines before this RFC3339 date"
@Param after query string false "only return pipelines after this RFC3339 date"
@Param branch query string false "filter pipelines by branch"
@Param event query string false "filter pipelines by webhook events (comma separated)"
@Param ref query string false "filter pipelines by strings contained in ref"
@Param status query string false "filter pipelines by status"
func GetQueueInfo ¶
GetQueueInfo
@Summary Get pipeline queue information
@Description TODO: link the InfoT response object - this is blocked, until the `swaggo/swag` tool dependency is v1.18.12 or newer
@Router /queue/info [get]
@Produce json
@Success 200 {object} map[string]string
@Tags Pipeline queues
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
func GetRegistry ¶
GetRegistry
@Summary Get a registry by name
@Router /repos/{repo_id}/registries/{registry} [get]
@Produce json
@Success 200 {object} Registry
@Tags Repository registries
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param registry path string true "the registry name"
func GetRegistryList ¶
GetRegistryList
@Summary List registries
@Router /repos/{repo_id}/registries [get]
@Produce json
@Success 200 {array} Registry
@Tags Repository registries
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param page query int false "for response pagination, page offset number" default(1)
@Param perPage query int false "for response pagination, max items per page" default(50)
func GetRepo ¶
GetRepo
@Summary Get a repository
@Router /repos/{repo_id} [get]
@Produce json
@Success 200 {object} Repo
@Tags Repositories
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
func GetRepoBranches ¶
GetRepoBranches
@Summary Get branches of a repository
@Router /repos/{repo_id}/branches [get]
@Produce json
@Success 200 {array} string
@Tags Repositories
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param page query int false "for response pagination, page offset number" default(1)
@Param perPage query int false "for response pagination, max items per page" default(50)
func GetRepoPermissions ¶
GetRepoPermissions
@Summary Check current authenticated users access to the repository
@Description The repository permission, according to the used access token.
@Router /repos/{repo_id}/permissions [get]
@Produce json
@Success 200 {object} Perm
@Tags Repositories
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
func GetRepoPullRequests ¶
GetRepoPullRequests
@Summary List active pull requests of a repository
@Router /repos/{repo_id}/pull_requests [get]
@Produce json
@Success 200 {array} PullRequest
@Tags Repositories
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param page query int false "for response pagination, page offset number" default(1)
@Param perPage query int false "for response pagination, max items per page" default(50)
func GetRepos ¶
GetRepos
@Summary Get user's repositories
@Description Retrieve the currently authenticated User's Repository list
@Router /user/repos [get]
@Produce json
@Success 200 {array} Repo
@Tags User
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param all query bool false "query all repos, including inactive ones"
func GetSecret ¶
GetSecret
@Summary Get a repository secret by name
@Router /repos/{repo_id}/secrets/{secretName} [get]
@Produce json
@Success 200 {object} Secret
@Tags Repository secrets
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param secretName path string true "the secret name"
func GetSecretList ¶
GetSecretList
@Summary List repository secrets
@Router /repos/{repo_id}/secrets [get]
@Produce json
@Success 200 {array} Secret
@Tags Repository secrets
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param page query int false "for response pagination, page offset number" default(1)
@Param perPage query int false "for response pagination, max items per page" default(50)
func GetSelf ¶
GetSelf
@Summary Get the currently authenticated user
@Router /user [get]
@Produce json
@Success 200 {object} User
@Tags User
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
func GetSignaturePublicKey ¶
GetSignaturePublicKey
@Summary Get server's signature public key @Router /signature/public-key [get] @Produce plain @Success 200 @Tags System @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
func GetStepLogs ¶
GetStepLogs
@Summary Get logs for a pipeline step
@Router /repos/{repo_id}/logs/{number}/{stepID} [get]
@Produce json
@Success 200 {array} LogEntry
@Tags Pipeline logs
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param number path int true "the number of the pipeline"
@Param stepID path int true "the step id"
func GetUser ¶
GetUser
@Summary Get a user
@Description Returns a user with the specified login name. Requires admin rights.
@Router /users/{login} [get]
@Produce json
@Success 200 {object} User
@Tags Users
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param login path string true "the user's login name"
func GetUsers ¶
GetUsers
@Summary List users
@Description Returns all registered, active users in the system. Requires admin rights.
@Router /users [get]
@Produce json
@Success 200 {array} User
@Tags Users
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param page query int false "for response pagination, page offset number" default(1)
@Param perPage query int false "for response pagination, max items per page" default(50)
func HandleAuth ¶
func Health ¶
Health
@Summary Health information @Description If everything is fine, just a 204 will be returned, a 500 signals server state is unhealthy. @Router /healthz [get] @Produce plain @Success 204 @Failure 500 @Tags System
func LogLevel ¶
LogLevel
@Summary Current log level
@Description Endpoint returns the current logging level. Requires admin rights.
@Router /log-level [get]
@Produce json
@Success 200 {object} object{log-level=string}
@Tags System
func LogStreamSSE ¶
LogStreamSSE
@Summary Stream logs of a pipeline step
@Router /stream/logs/{repo_id}/{pipeline}/{stepID} [get]
@Produce plain
@Success 200
@Tags Pipeline logs
@Param repo_id path int true "the repository id"
@Param pipeline path int true "the number of the pipeline"
@Param stepID path int true "the step id"
func LookupOrg ¶
LookupOrg
@Summary Lookup an organization by full name
@Router /org/lookup/{org_full_name} [get]
@Produce json
@Success 200 {object} Org
@Tags Organizations
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param org_full_name path string true "the organizations full name / slug"
func LookupRepo ¶
LookupRepo
@Summary Lookup a repository by full name
@Router /repos/lookup/{repo_full_name} [get]
@Produce json
@Success 200 {object} Repo
@Tags Repositories
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_full_name path string true "the repository full name / slug"
func MoveRepo ¶
MoveRepo
@Summary Move a repository to a new owner
@Router /repos/{repo_id}/move [post]
@Produce plain
@Success 204
@Tags Repositories
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param to query string true "the username to move the repository to"
func PatchAgent ¶
PatchAgent
@Summary Update an agent
@Router /agents/{agent_id} [patch]
@Produce json
@Success 200 {object} Agent
@Tags Agents
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param agent_id path int true "the agent's id"
@Param agentData body Agent true "the agent's data"
func PatchCron ¶
PatchCron
@Summary Update a cron job
@Router /repos/{repo_id}/cron/{cron} [patch]
@Produce json
@Success 200 {object} Cron
@Tags Repository cron jobs
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param cron path string true "the cron job id"
@Param cronJob body Cron true "the cron job data"
func PatchForge ¶
PatchForge
@Summary Update a forge
@Router /forges/{forgeId} [patch]
@Produce json
@Success 200 {object} Forge
@Tags Forges
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param forgeId path int true "the forge's id"
@Param forgeData body Forge true "the forge's data"
func PatchGlobalRegistry ¶
PatchGlobalRegistry
@Summary Update a global registry by name
@Router /registries/{registry} [patch]
@Produce json
@Success 200 {object} Registry
@Tags Registries
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param registry path string true "the registry's name"
@Param registryData body Registry true "the registry's data"
func PatchGlobalSecret ¶
PatchGlobalSecret
@Summary Update a global secret by name
@Router /secrets/{secret} [patch]
@Produce json
@Success 200 {object} Secret
@Tags Secrets
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param secret path string true "the secret's name"
@Param secretData body Secret true "the secret's data"
func PatchOrgAgent ¶
PatchOrgAgent
@Summary Update an organization-scoped agent
@Router /orgs/{org_id}/agents/{agent_id} [patch]
@Produce json
@Success 200 {object} Agent
@Tags Agents
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param org_id path int true "the organization's id"
@Param agent_id path int true "the agent's id"
@Param agent body Agent true "the agent's updated data"
func PatchOrgRegistry ¶
PatchOrgRegistry
@Summary Update an organization registry by name
@Router /orgs/{org_id}/registries/{registry} [patch]
@Produce json
@Success 200 {object} Registry
@Tags Organization registries
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param org_id path string true "the org's id"
@Param registry path string true "the registry's name"
@Param registryData body Registry true "the update registry data"
func PatchOrgSecret ¶
PatchOrgSecret
@Summary Update an organization secret by name
@Router /orgs/{org_id}/secrets/{secret} [patch]
@Produce json
@Success 200 {object} Secret
@Tags Organization secrets
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param org_id path string true "the org's id"
@Param secret path string true "the secret's name"
@Param secretData body Secret true "the update secret data"
func PatchRegistry ¶
PatchRegistry
@Summary Update a registry by name
@Router /repos/{repo_id}/registries/{registry} [patch]
@Produce json
@Success 200 {object} Registry
@Tags Repository registries
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param registry path string true "the registry name"
@Param registryData body Registry true "the attributes for the registry"
func PatchRepo ¶
PatchRepo
@Summary Update a repository
@Router /repos/{repo_id} [patch]
@Produce json
@Success 200 {object} Repo
@Tags Repositories
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param repo body RepoPatch true "the repository's information"
func PatchSecret ¶
PatchSecret
@Summary Update a repository secret by name
@Router /repos/{repo_id}/secrets/{secretName} [patch]
@Produce json
@Success 200 {object} Secret
@Tags Repository secrets
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param secretName path string true "the secret name"
@Param secret body Secret true "the secret itself"
func PatchUser ¶
PatchUser
@Summary Update a user
@Description Changes the data of an existing user. Requires admin rights.
@Router /users/{login} [patch]
@Produce json
@Accept json
@Success 200 {object} User
@Tags Users
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param login path string true "the user's login name"
@Param user body User true "the user's data"
func PauseQueue ¶
PauseQueue
@Summary Pause the pipeline queue @Router /queue/pause [post] @Produce plain @Success 204 @Tags Pipeline queues @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
func PostAgent ¶
PostAgent
@Summary Create a new agent
@Description Creates a new agent with a random token
@Router /agents [post]
@Produce json
@Success 200 {object} Agent
@Tags Agents
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param agent body Agent true "the agent's data (only 'name' and 'no_schedule' are read)"
func PostApproval ¶
PostApproval
@Summary Approve and start a pipeline
@Router /repos/{repo_id}/pipelines/{number}/approve [post]
@Produce json
@Success 200 {object} Pipeline
@Tags Pipelines
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param number path int true "the number of the pipeline"
func PostCron ¶
PostCron
@Summary Create a cron job
@Router /repos/{repo_id}/cron [post]
@Produce json
@Success 200 {object} Cron
@Tags Repository cron jobs
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param cronJob body Cron true "the new cron job"
func PostDecline ¶
PostDecline
@Summary Decline a pipeline
@Router /repos/{repo_id}/pipelines/{number}/decline [post]
@Produce json
@Success 200 {object} Pipeline
@Tags Pipelines
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param number path int true "the number of the pipeline"
func PostForge ¶
PostForge
@Summary Create a new forge
@Description Creates a new forge with a random token
@Router /forges [post]
@Produce json
@Success 200 {object} Forge
@Tags Forges
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param forge body Forge true "the forge's data (only 'name' and 'no_schedule' are read)"
func PostGlobalRegistry ¶
PostGlobalRegistry
@Summary Create a global registry
@Router /registries [post]
@Produce json
@Success 200 {object} Registry
@Tags Registries
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param registry body Registry true "the registry object data"
func PostGlobalSecret ¶
PostGlobalSecret
@Summary Create a global secret
@Router /secrets [post]
@Produce json
@Success 200 {object} Secret
@Tags Secrets
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param secret body Secret true "the secret object data"
func PostHook ¶
PostHook
@Summary Incoming webhook from forge @Router /hook [post] @Produce plain @Success 200 @Tags System @Param hook body object true "the webhook payload; forge is automatically detected"
func PostOrgAgent ¶
PostOrgAgent
@Summary Create a new organization-scoped agent
@Description Creates a new agent with a random token, scoped to the specified organization
@Router /orgs/{org_id}/agents [post]
@Produce json
@Success 200 {object} Agent
@Tags Agents
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param org_id path int true "the organization's id"
@Param agent body Agent true "the agent's data (only 'name' and 'no_schedule' are read)"
func PostOrgRegistry ¶
PostOrgRegistry
@Summary Create an organization registry
@Router /orgs/{org_id}/registries [post]
@Produce json
@Success 200 {object} Registry
@Tags Organization registries
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param org_id path string true "the org's id"
@Param registryData body Registry true "the new registry"
func PostOrgSecret ¶
PostOrgSecret
@Summary Create an organization secret
@Router /orgs/{org_id}/secrets [post]
@Produce json
@Success 200 {object} Secret
@Tags Organization secrets
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param org_id path string true "the org's id"
@Param secretData body Secret true "the new secret"
func PostPipeline ¶
PostPipeline
@Summary Restart a pipeline
@Description Restarts a pipeline optional with altered event, deploy or environment
@Router /repos/{repo_id}/pipelines/{number} [post]
@Produce json
@Success 200 {object} Pipeline
@Tags Pipelines
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param number path int true "the number of the pipeline"
@Param event query string false "override the event type"
@Param deploy_to query string false "override the target deploy value"
func PostRegistry ¶
PostRegistry
@Summary Create a registry
@Router /repos/{repo_id}/registries [post]
@Produce json
@Success 200 {object} Registry
@Tags Repository registries
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param registry body Registry true "the new registry data"
func PostRepo ¶
PostRepo
@Summary Activate a repository
@Router /repos [post]
@Produce json
@Success 200 {object} Repo
@Tags Repositories
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param forge_remote_id query string true "the id of a repository at the forge"
func PostSecret ¶
PostSecret
@Summary Create a repository secret
@Router /repos/{repo_id}/secrets [post]
@Produce json
@Success 200 {object} Secret
@Tags Repository secrets
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param secret body Secret true "the new secret"
func PostToken ¶
PostToken
@Summary Return the token of the current user as string @Router /user/token [post] @Produce plain @Success 200 @Tags User @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
func PostUser ¶
PostUser
@Summary Create a user
@Description Creates a new user account with the specified external login. Requires admin rights.
@Router /users [post]
@Produce json
@Success 200 {object} User
@Tags Users
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param user body User true "the user's data"
func RepairAllRepos ¶
RepairAllRepos
@Summary Repair all repositories on the server @Description Executes a repair process on all repositories. Requires admin rights. @Router /repos/repair [post] @Produce plain @Success 204 @Tags Repositories @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
func RepairRepo ¶
RepairRepo
@Summary Repair a repository
@Router /repos/{repo_id}/repair [post]
@Produce plain
@Success 204
@Tags Repositories
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
func ResumeQueue ¶
ResumeQueue
@Summary Resume the pipeline queue @Router /queue/resume [post] @Produce plain @Success 204 @Tags Pipeline queues @Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
func RunCron ¶
RunCron
@Summary Start a cron job now
@Router /repos/{repo_id}/cron/{cron} [post]
@Produce json
@Success 200 {object} Pipeline
@Tags Repository cron jobs
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param repo_id path int true "the repository id"
@Param cron path string true "the cron job id"
func SetLogLevel ¶
SetLogLevel
@Summary Set log level
@Description Endpoint sets the current logging level. Requires admin rights.
@Router /log-level [post]
@Produce json
@Success 200 {object} object{log-level=string}
@Tags System
@Param Authorization header string true "Insert your personal access token" default(Bearer <personal access token>)
@Param log-level body object{log-level=string} true "the new log level, one of <debug,trace,info,warn,error,fatal,panic,disabled>"
Types ¶
This section is empty.
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.