2023-09-01 14:44:55 +00:00
// Package docs Code generated by swaggo/swag. DO NOT EDIT
2023-06-03 19:38:36 +00:00
package docs
import "github.com/swaggo/swag"
const docTemplate = ` {
"schemes" : { { marshal . Schemes } } ,
"swagger" : "2.0" ,
"info" : {
"description" : "{{escape .Description}}" ,
"title" : "{{.Title}}" ,
"contact" : {
"name" : "Woodpecker CI Community" ,
"url" : "https://woodpecker-ci.org/"
} ,
"version" : "{{.Version}}"
} ,
"host" : "{{.Host}}" ,
"basePath" : "{{.BasePath}}" ,
"paths" : {
"/agents" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Agents"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "List agents" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"default" : 1 ,
"description" : "for response pagination, page offset number" ,
"name" : "page" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"default" : 50 ,
"description" : "for response pagination, max items per page" ,
"name" : "perPage" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Agent"
}
}
}
}
} ,
"post" : {
2024-05-01 09:50:41 +00:00
"description" : "Creates a new agent with a random token" ,
2023-06-03 19:38:36 +00:00
"produces" : [
"application/json"
] ,
"tags" : [
"Agents"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Create a new agent" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"description" : "the agent's data (only 'name' and 'no_schedule' are read)" ,
"name" : "agent" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Agent"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Agent"
}
}
}
}
} ,
2024-09-30 11:33:16 +00:00
"/agents/{agent_id}" : {
2023-06-03 19:38:36 +00:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Agents"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Get an agent" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the agent's id" ,
"name" : "agent" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Agent"
}
}
}
} ,
"delete" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Agents"
] ,
"summary" : "Delete an agent" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the agent's id" ,
"name" : "agent" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
} ,
"patch" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Agents"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Update an agent" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the agent's id" ,
"name" : "agent" ,
"in" : "path" ,
"required" : true
} ,
{
"description" : "the agent's data" ,
"name" : "agentData" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Agent"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Agent"
}
}
}
}
} ,
2024-09-30 11:33:16 +00:00
"/agents/{agent_id}/tasks" : {
2023-06-03 19:38:36 +00:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Agents"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "List agent tasks" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the agent's id" ,
"name" : "agent" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Task"
}
}
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/badges/{repo_id}/cc.xml" : {
2023-06-03 19:38:36 +00:00
"get" : {
"description" : "CCMenu displays the pipeline status of projects on a CI server as an item in the Mac's menu bar.\nMore details on how to install, you can find at http://ccmenu.org/\nThe response format adheres to CCTray v1 Specification, https://cctray.org/v1/" ,
"produces" : [
"text/xml"
] ,
"tags" : [
"Badges"
] ,
"summary" : "Provide pipeline status information to the CCMenu tool" ,
"parameters" : [
{
2023-12-24 14:50:01 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/badges/{repo_id}/status.svg" : {
2023-06-03 19:38:36 +00:00
"get" : {
"produces" : [
"image/svg+xml"
] ,
"tags" : [
"Badges"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Get status of pipeline as SVG badge" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
}
} ,
"/debug/pprof" : {
"get" : {
"description" : "Only available, when server was started with WOODPECKER_LOG_LEVEL=debug" ,
"produces" : [
"text/html"
] ,
"tags" : [
"Process profiling and debugging"
] ,
"summary" : "List available pprof profiles (HTML)" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
}
} ,
"/debug/pprof/block" : {
"get" : {
"description" : "Only available, when server was started with WOODPECKER_LOG_LEVEL=debug" ,
"produces" : [
"text/plain"
] ,
"tags" : [
"Process profiling and debugging"
] ,
"summary" : "Get pprof stack traces that led to blocking on synchronization primitives" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
}
} ,
"/debug/pprof/cmdline" : {
"get" : {
"description" : "Only available, when server was started with WOODPECKER_LOG_LEVEL=debug" ,
"produces" : [
"text/plain"
] ,
"tags" : [
"Process profiling and debugging"
] ,
"summary" : "Get the command line invocation of the current program" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
}
} ,
"/debug/pprof/goroutine" : {
"get" : {
"description" : "Only available, when server was started with WOODPECKER_LOG_LEVEL=debug" ,
"produces" : [
"text/plain"
] ,
"tags" : [
"Process profiling and debugging"
] ,
"summary" : "Get pprof stack traces of all current goroutines" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"default" : 1 ,
"description" : "Use debug=2 as a query parameter to export in the same format as an un-recovered panic" ,
"name" : "debug" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
}
} ,
"/debug/pprof/heap" : {
"get" : {
"description" : "Only available, when server was started with WOODPECKER_LOG_LEVEL=debug" ,
"produces" : [
"text/plain"
] ,
"tags" : [
"Process profiling and debugging"
] ,
"summary" : "Get pprof heap dump, a sampling of memory allocations of live objects" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
"default" : "" ,
"description" : "You can specify gc=heap to run GC before taking the heap sample" ,
"name" : "gc" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
}
} ,
"/debug/pprof/profile" : {
"get" : {
"description" : "Only available, when server was started with WOODPECKER_LOG_LEVEL=debug\nAfter you get the profile file, use the go tool pprof command to investigate the profile." ,
"produces" : [
"text/plain"
] ,
"tags" : [
"Process profiling and debugging"
] ,
"summary" : "Get pprof CPU profile" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "You can specify the duration in the seconds GET parameter." ,
"name" : "seconds" ,
"in" : "query" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
}
} ,
"/debug/pprof/symbol" : {
"get" : {
"description" : "Only available, when server was started with WOODPECKER_LOG_LEVEL=debug\nLooks up the program counters listed in the request,\nresponding with a table mapping program counters to function names.\nThe requested program counters can be provided via GET + query parameters,\nor POST + body parameters. Program counters shall be space delimited." ,
"produces" : [
"text/plain"
] ,
"tags" : [
"Process profiling and debugging"
] ,
"summary" : "Get pprof program counters mapping to function names" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
} ,
"post" : {
"description" : "Only available, when server was started with WOODPECKER_LOG_LEVEL=debug\nLooks up the program counters listed in the request,\nresponding with a table mapping program counters to function names.\nThe requested program counters can be provided via GET + query parameters,\nor POST + body parameters. Program counters shall be space delimited." ,
"produces" : [
"text/plain"
] ,
"tags" : [
"Process profiling and debugging"
] ,
"summary" : "Get pprof program counters mapping to function names" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
}
} ,
"/debug/pprof/threadcreate" : {
"get" : {
"description" : "Only available, when server was started with WOODPECKER_LOG_LEVEL=debug" ,
"produces" : [
"text/plain"
] ,
"tags" : [
"Process profiling and debugging"
] ,
"summary" : "Get pprof stack traces that led to the creation of new OS threads" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
}
} ,
"/debug/pprof/trace" : {
"get" : {
"description" : "Only available, when server was started with WOODPECKER_LOG_LEVEL=debug\nAfter you get the profile file, use the go tool pprof command to investigate the profile." ,
"produces" : [
"text/plain"
] ,
"tags" : [
"Process profiling and debugging"
] ,
"summary" : "Get a trace of execution of the current program" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "You can specify the duration in the seconds GET parameter." ,
"name" : "seconds" ,
"in" : "query" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
}
} ,
2024-06-20 11:08:54 +00:00
"/forges" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Forges"
] ,
"summary" : "List forges" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header"
} ,
{
"type" : "integer" ,
"default" : 1 ,
"description" : "for response pagination, page offset number" ,
"name" : "page" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"default" : 50 ,
"description" : "for response pagination, max items per page" ,
"name" : "perPage" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Forge"
}
}
}
}
} ,
"post" : {
"description" : "Creates a new forge with a random token" ,
"produces" : [
"application/json"
] ,
"tags" : [
"Forges"
] ,
"summary" : "Create a new forge" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"description" : "the forge's data (only 'name' and 'no_schedule' are read)" ,
"name" : "forge" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Forge"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Forge"
}
}
}
}
} ,
"/forges/{forgeId}" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Forges"
] ,
"summary" : "Get a forge" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header"
} ,
{
"type" : "integer" ,
"description" : "the forge's id" ,
"name" : "forgeId" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Forge"
}
}
}
} ,
"delete" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Forges"
] ,
"summary" : "Delete a forge" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the forge's id" ,
"name" : "forgeId" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
} ,
"patch" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Forges"
] ,
"summary" : "Update a forge" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the forge's id" ,
"name" : "forgeId" ,
"in" : "path" ,
"required" : true
} ,
{
"description" : "the forge's data" ,
"name" : "forgeData" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Forge"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Forge"
}
}
}
}
} ,
2023-06-03 19:38:36 +00:00
"/healthz" : {
"get" : {
2023-09-02 11:31:10 +00:00
"description" : "If everything is fine, just a 204 will be returned, a 500 signals server state is unhealthy." ,
2023-06-03 19:38:36 +00:00
"produces" : [
"text/plain"
] ,
"tags" : [
"System"
] ,
"summary" : "Health information" ,
"responses" : {
2023-09-02 11:31:10 +00:00
"204" : {
"description" : "No Content"
2023-06-03 19:38:36 +00:00
} ,
"500" : {
"description" : "Internal Server Error"
}
}
}
} ,
"/hook" : {
"post" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"System"
] ,
"summary" : "Incoming webhook from forge" ,
"parameters" : [
{
"description" : "the webhook payload; forge is automatically detected" ,
"name" : "hook" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"type" : "object"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
}
} ,
"/log-level" : {
"get" : {
"description" : "Endpoint returns the current logging level. Requires admin rights." ,
"produces" : [
"application/json"
] ,
"tags" : [
"System"
] ,
"summary" : "Current log level" ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2024-07-13 13:55:13 +00:00
"type" : "object" ,
"properties" : {
"log-level" : {
2023-06-03 19:38:36 +00:00
"type" : "string"
}
2024-07-13 13:55:13 +00:00
}
2023-06-03 19:38:36 +00:00
}
}
}
} ,
"post" : {
"description" : "Endpoint sets the current logging level. Requires admin rights." ,
"produces" : [
"application/json"
] ,
"tags" : [
"System"
] ,
"summary" : "Set log level" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"description" : "the new log level, one of \u003cdebug,trace,info,warn,error,fatal,panic,disabled\u003e" ,
"name" : "log-level" ,
"in" : "body" ,
"required" : true ,
"schema" : {
2024-07-13 13:55:13 +00:00
"type" : "object" ,
"properties" : {
"log-level" : {
2023-06-03 19:38:36 +00:00
"type" : "string"
}
2024-07-13 13:55:13 +00:00
}
2023-06-03 19:38:36 +00:00
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2024-07-13 13:55:13 +00:00
"type" : "object" ,
"properties" : {
"log-level" : {
2023-06-03 19:38:36 +00:00
"type" : "string"
}
2024-07-13 13:55:13 +00:00
}
2023-06-03 19:38:36 +00:00
}
}
}
}
} ,
2023-07-21 17:45:32 +00:00
"/org/lookup/{org_full_name}" : {
2023-06-03 19:38:36 +00:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
2023-07-21 17:45:32 +00:00
"Organizations"
2023-06-03 19:38:36 +00:00
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Lookup an organization by full name" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
2024-05-01 09:50:41 +00:00
"description" : "the organizations full name / slug" ,
2023-07-21 17:45:32 +00:00
"name" : "org_full_name" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2023-07-21 17:45:32 +00:00
"$ref" : "#/definitions/Org"
2023-06-03 19:38:36 +00:00
}
}
}
}
} ,
2023-08-28 09:15:16 +00:00
"/orgs" : {
"get" : {
"description" : "Returns all registered orgs in the system. Requires admin rights." ,
"produces" : [
"application/json"
] ,
"tags" : [
"Orgs"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "List organizations" ,
2023-08-28 09:15:16 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"default" : 1 ,
"description" : "for response pagination, page offset number" ,
"name" : "page" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"default" : 50 ,
"description" : "for response pagination, max items per page" ,
"name" : "perPage" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Org"
}
}
}
}
}
} ,
"/orgs/{id}" : {
"delete" : {
"description" : "Deletes the given org. Requires admin rights." ,
"produces" : [
2023-09-02 11:31:10 +00:00
"text/plain"
2023-08-28 09:15:16 +00:00
] ,
"tags" : [
"Orgs"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Delete an organization" ,
2023-08-28 09:15:16 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the org's id" ,
"name" : "id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
2023-09-02 11:31:10 +00:00
"description" : "No Content"
2023-08-28 09:15:16 +00:00
}
}
}
} ,
2023-07-21 17:45:32 +00:00
"/orgs/{org_id}" : {
2023-06-03 19:38:36 +00:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
2023-07-21 17:45:32 +00:00
"Organization"
2023-06-03 19:38:36 +00:00
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Get an organization" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
2024-06-04 06:30:54 +00:00
"description" : "the organization's id" ,
2023-07-21 17:45:32 +00:00
"name" : "org_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
2023-07-21 17:45:32 +00:00
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Org"
}
}
}
}
}
} ,
2024-09-30 11:33:16 +00:00
"/orgs/{org_id}/agents" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Agents"
] ,
"summary" : "List agents for an organization" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the organization's id" ,
"name" : "org_id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"default" : 1 ,
"description" : "for response pagination, page offset number" ,
"name" : "page" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"default" : 50 ,
"description" : "for response pagination, max items per page" ,
"name" : "perPage" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Agent"
}
}
}
}
} ,
"post" : {
"description" : "Creates a new agent with a random token, scoped to the specified organization" ,
"produces" : [
"application/json"
] ,
"tags" : [
"Agents"
] ,
"summary" : "Create a new organization-scoped agent" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the organization's id" ,
"name" : "org_id" ,
"in" : "path" ,
"required" : true
} ,
{
"description" : "the agent's data (only 'name' and 'no_schedule' are read)" ,
"name" : "agent" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Agent"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Agent"
}
}
}
}
} ,
"/orgs/{org_id}/agents/{agent_id}" : {
"delete" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Agents"
] ,
"summary" : "Delete an organization-scoped agent" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the organization's id" ,
"name" : "org_id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the agent's id" ,
"name" : "agent_id" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"description" : "No Content"
}
}
} ,
"patch" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Agents"
] ,
"summary" : "Update an organization-scoped agent" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the organization's id" ,
"name" : "org_id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the agent's id" ,
"name" : "agent_id" ,
"in" : "path" ,
"required" : true
} ,
{
"description" : "the agent's updated data" ,
"name" : "agent" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Agent"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Agent"
}
}
}
}
} ,
2023-07-21 17:45:32 +00:00
"/orgs/{org_id}/permissions" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Organization permissions"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Get the permissions of the currently authenticated user for the given organization" ,
2023-07-21 17:45:32 +00:00
"parameters" : [
2023-06-03 19:38:36 +00:00
{
2023-07-21 17:45:32 +00:00
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
2023-06-03 19:38:36 +00:00
} ,
{
2023-07-21 17:45:32 +00:00
"type" : "string" ,
2024-06-04 06:30:54 +00:00
"description" : "the organization's id" ,
2023-07-21 17:45:32 +00:00
"name" : "org_id" ,
"in" : "path" ,
"required" : true
2023-06-03 19:38:36 +00:00
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
2023-07-21 17:45:32 +00:00
"$ref" : "#/definitions/OrgPerm"
2023-06-03 19:38:36 +00:00
}
}
}
}
2023-07-21 17:45:32 +00:00
}
} ,
2024-07-03 13:33:11 +00:00
"/orgs/{org_id}/registries" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Organization registries"
] ,
"summary" : "List organization registries" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the org's id" ,
"name" : "org_id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"default" : 1 ,
"description" : "for response pagination, page offset number" ,
"name" : "page" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"default" : 50 ,
"description" : "for response pagination, max items per page" ,
"name" : "perPage" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Registry"
}
}
}
}
} ,
"post" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Organization registries"
] ,
"summary" : "Create an organization registry" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the org's id" ,
"name" : "org_id" ,
"in" : "path" ,
"required" : true
} ,
{
"description" : "the new registry" ,
"name" : "registryData" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Registry"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Registry"
}
}
}
}
} ,
"/orgs/{org_id}/registries/{registry}" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Organization registries"
] ,
"summary" : "Get a organization registry by address" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the org's id" ,
"name" : "org_id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the registry's address" ,
"name" : "registry" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Registry"
}
}
}
} ,
"delete" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Organization registries"
] ,
"summary" : "Delete an organization registry by name" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the org's id" ,
"name" : "org_id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the registry's name" ,
"name" : "registry" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"description" : "No Content"
}
}
} ,
"patch" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Organization registries"
] ,
"summary" : "Update an organization registry by name" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the org's id" ,
"name" : "org_id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the registry's name" ,
"name" : "registry" ,
"in" : "path" ,
"required" : true
} ,
{
"description" : "the update registry data" ,
"name" : "registryData" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Registry"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Registry"
}
}
}
}
} ,
2023-07-21 17:45:32 +00:00
"/orgs/{org_id}/secrets" : {
"get" : {
2023-06-03 19:38:36 +00:00
"produces" : [
"application/json"
] ,
"tags" : [
"Organization secrets"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "List organization secrets" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
2023-07-21 17:45:32 +00:00
"description" : "the org's id" ,
"name" : "org_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
2023-07-21 17:45:32 +00:00
"type" : "integer" ,
"default" : 1 ,
"description" : "for response pagination, page offset number" ,
"name" : "page" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"default" : 50 ,
"description" : "for response pagination, max items per page" ,
"name" : "perPage" ,
"in" : "query"
2023-06-03 19:38:36 +00:00
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2023-07-21 17:45:32 +00:00
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Secret"
}
2023-06-03 19:38:36 +00:00
}
}
}
2023-12-24 14:50:01 +00:00
} ,
"post" : {
2023-06-03 19:38:36 +00:00
"produces" : [
"application/json"
] ,
"tags" : [
"Organization secrets"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Create an organization secret" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
2023-07-21 17:45:32 +00:00
"description" : "the org's id" ,
"name" : "org_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
2023-12-24 14:50:01 +00:00
"description" : "the new secret" ,
"name" : "secretData" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Secret"
}
2023-06-03 19:38:36 +00:00
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Secret"
}
}
}
2023-12-24 14:50:01 +00:00
}
} ,
"/orgs/{org_id}/secrets/{secret}" : {
"get" : {
2023-06-03 19:38:36 +00:00
"produces" : [
2023-12-24 14:50:01 +00:00
"application/json"
2023-06-03 19:38:36 +00:00
] ,
"tags" : [
"Organization secrets"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Get a organization secret by name" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
2023-07-21 17:45:32 +00:00
"description" : "the org's id" ,
"name" : "org_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the secret's name" ,
"name" : "secret" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
2023-12-24 14:50:01 +00:00
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Secret"
}
2023-06-03 19:38:36 +00:00
}
}
} ,
2023-12-24 14:50:01 +00:00
"delete" : {
2023-06-03 19:38:36 +00:00
"produces" : [
2023-12-24 14:50:01 +00:00
"text/plain"
2023-06-03 19:38:36 +00:00
] ,
"tags" : [
"Organization secrets"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Delete an organization secret by name" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
2023-07-21 17:45:32 +00:00
"description" : "the org's id" ,
"name" : "org_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the secret's name" ,
"name" : "secret" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
2023-12-24 14:50:01 +00:00
"204" : {
"description" : "No Content"
2023-06-03 19:38:36 +00:00
}
}
2023-12-24 14:50:01 +00:00
} ,
"patch" : {
2023-07-21 17:45:32 +00:00
"produces" : [
"application/json"
] ,
"tags" : [
"Organization secrets"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Update an organization secret by name" ,
2023-07-21 17:45:32 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the org's id" ,
"name" : "org_id" ,
"in" : "path" ,
"required" : true
} ,
{
2023-12-24 14:50:01 +00:00
"type" : "string" ,
"description" : "the secret's name" ,
"name" : "secret" ,
"in" : "path" ,
"required" : true
} ,
{
"description" : "the update secret data" ,
2023-07-21 17:45:32 +00:00
"name" : "secretData" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Secret"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Secret"
}
}
}
}
} ,
2023-06-03 19:38:36 +00:00
"/pipelines" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Pipeline queues"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "List pipelines in queue" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Feed"
}
}
}
}
}
} ,
"/queue/info" : {
"get" : {
"description" : "TODO: link the InfoT response object - this is blocked, until the ` + " ` " + ` swaggo / swag ` + " ` " + ` tool dependency is v1.18.12 or newer" ,
"produces" : [
"application/json"
] ,
"tags" : [
"Pipeline queues"
] ,
"summary" : "Get pipeline queue information" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "object" ,
"additionalProperties" : {
"type" : "string"
}
}
}
}
}
} ,
"/queue/norunningpipelines" : {
"get" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Pipeline queues"
] ,
"summary" : "Block til pipeline queue has a running item" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
}
] ,
"responses" : {
2023-10-28 11:37:54 +00:00
"204" : {
"description" : "No Content"
2023-06-03 19:38:36 +00:00
}
}
}
} ,
"/queue/pause" : {
"post" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Pipeline queues"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Pause the pipeline queue" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
}
] ,
"responses" : {
2023-10-28 11:37:54 +00:00
"204" : {
"description" : "No Content"
2023-06-03 19:38:36 +00:00
}
}
}
} ,
"/queue/resume" : {
"post" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Pipeline queues"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Resume the pipeline queue" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
}
] ,
"responses" : {
2023-10-28 11:37:54 +00:00
"204" : {
"description" : "No Content"
2023-06-03 19:38:36 +00:00
}
}
}
} ,
2024-07-03 13:33:11 +00:00
"/registries" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Registries"
] ,
"summary" : "List global registries" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"default" : 1 ,
"description" : "for response pagination, page offset number" ,
"name" : "page" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"default" : 50 ,
"description" : "for response pagination, max items per page" ,
"name" : "perPage" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Registry"
}
}
}
}
} ,
"post" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Registries"
] ,
"summary" : "Create a global registry" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"description" : "the registry object data" ,
"name" : "registry" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Registry"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Registry"
}
}
}
}
} ,
"/registries/{registry}" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Registries"
] ,
"summary" : "Get a global registry by name" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the registry's name" ,
"name" : "registry" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Registry"
}
}
}
} ,
"delete" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Registries"
] ,
"summary" : "Delete a global registry by name" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the registry's name" ,
"name" : "registry" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"description" : "No Content"
}
}
} ,
"patch" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Registries"
] ,
"summary" : "Update a global registry by name" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the registry's name" ,
"name" : "registry" ,
"in" : "path" ,
"required" : true
} ,
{
"description" : "the registry's data" ,
"name" : "registryData" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Registry"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Registry"
}
}
}
}
} ,
2023-07-11 16:51:03 +00:00
"/repos" : {
2023-09-08 10:26:20 +00:00
"get" : {
2024-05-01 09:50:41 +00:00
"description" : "Returns a list of all repositories. Requires admin rights." ,
2023-09-08 10:26:20 +00:00
"produces" : [
"application/json"
] ,
"tags" : [
"Repositories"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "List all repositories on the server" ,
2023-09-08 10:26:20 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "boolean" ,
"description" : "only list active repos" ,
"name" : "active" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"default" : 1 ,
"description" : "for response pagination, page offset number" ,
"name" : "page" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"default" : 50 ,
"description" : "for response pagination, max items per page" ,
"name" : "perPage" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Repo"
}
}
}
}
} ,
2023-07-11 16:51:03 +00:00
"post" : {
2023-06-03 19:38:36 +00:00
"produces" : [
"application/json"
] ,
"tags" : [
"Repositories"
] ,
2023-07-11 16:51:03 +00:00
"summary" : "Activate a repository" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
2023-07-11 16:51:03 +00:00
"description" : "the id of a repository at the forge" ,
"name" : "forge_remote_id" ,
"in" : "query" ,
2023-06-03 19:38:36 +00:00
"required" : true
2023-06-12 23:07:52 +00:00
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Repo"
}
}
}
}
} ,
2023-07-11 16:51:03 +00:00
"/repos/lookup/{repo_full_name}" : {
2023-06-12 23:07:52 +00:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repositories"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Lookup a repository by full name" ,
2023-06-12 23:07:52 +00:00
"parameters" : [
2023-06-03 19:38:36 +00:00
{
"type" : "string" ,
2023-06-12 23:07:52 +00:00
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-07-11 16:51:03 +00:00
"type" : "string" ,
2024-05-01 09:50:41 +00:00
"description" : "the repository full name / slug" ,
2023-07-11 16:51:03 +00:00
"name" : "repo_full_name" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Repo"
}
}
}
2023-07-11 16:51:03 +00:00
}
} ,
2023-10-24 12:12:55 +00:00
"/repos/repair" : {
"post" : {
2024-05-01 09:50:41 +00:00
"description" : "Executes a repair process on all repositories. Requires admin rights." ,
2023-10-24 12:12:55 +00:00
"produces" : [
"text/plain"
] ,
"tags" : [
"Repositories"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Repair all repositories on the server" ,
2023-10-24 12:12:55 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"description" : "No Content"
}
}
}
} ,
2023-07-11 16:51:03 +00:00
"/repos/{repo_id}" : {
"get" : {
2023-06-03 19:38:36 +00:00
"produces" : [
"application/json"
] ,
"tags" : [
"Repositories"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Get a repository" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Repo"
}
}
}
} ,
"delete" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repositories"
] ,
"summary" : "Delete a repository" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Repo"
}
}
}
} ,
"patch" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repositories"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Update a repository" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"description" : "the repository's information" ,
"name" : "repo" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/RepoPatch"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Repo"
}
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/branches" : {
2023-06-03 19:38:36 +00:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repositories"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Get branches of a repository" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"default" : 1 ,
"description" : "for response pagination, page offset number" ,
"name" : "page" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"default" : 50 ,
"description" : "for response pagination, max items per page" ,
"name" : "perPage" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/chown" : {
2023-06-03 19:38:36 +00:00
"post" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repositories"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Change a repository's owner to the currently authenticated user" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Repo"
}
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/cron" : {
2023-06-03 19:38:36 +00:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repository cron jobs"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "List cron jobs" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"default" : 1 ,
"description" : "for response pagination, page offset number" ,
"name" : "page" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"default" : 50 ,
"description" : "for response pagination, max items per page" ,
"name" : "perPage" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Cron"
}
}
}
}
} ,
"post" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repository cron jobs"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Create a cron job" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"description" : "the new cron job" ,
"name" : "cronJob" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Cron"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Cron"
}
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/cron/{cron}" : {
2023-06-03 19:38:36 +00:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repository cron jobs"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Get a cron job" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the cron job id" ,
"name" : "cron" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Cron"
}
}
}
} ,
"post" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repository cron jobs"
] ,
"summary" : "Start a cron job now" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the cron job id" ,
"name" : "cron" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Pipeline"
}
}
}
} ,
"delete" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Repository cron jobs"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Delete a cron job" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the cron job id" ,
"name" : "cron" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
2023-09-02 11:31:10 +00:00
"204" : {
"description" : "No Content"
2023-06-03 19:38:36 +00:00
}
}
} ,
"patch" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repository cron jobs"
] ,
"summary" : "Update a cron job" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the cron job id" ,
"name" : "cron" ,
"in" : "path" ,
"required" : true
} ,
{
"description" : "the cron job data" ,
"name" : "cronJob" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Cron"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Cron"
}
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/logs/{number}" : {
2023-10-24 13:21:05 +00:00
"delete" : {
2023-06-03 19:38:36 +00:00
"produces" : [
"text/plain"
] ,
"tags" : [
"Pipeline logs"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Deletes all logs of a pipeline" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the number of the pipeline" ,
"name" : "number" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
2023-09-02 11:31:10 +00:00
"204" : {
"description" : "No Content"
2023-06-03 19:38:36 +00:00
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/logs/{number}/{stepID}" : {
2023-06-03 19:38:36 +00:00
"get" : {
"produces" : [
2023-06-06 07:52:08 +00:00
"application/json"
2023-06-03 19:38:36 +00:00
] ,
"tags" : [
"Pipeline logs"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Get logs for a pipeline step" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the number of the pipeline" ,
"name" : "number" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
2023-06-06 07:52:08 +00:00
"description" : "the step id" ,
"name" : "stepID" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
2023-06-06 07:52:08 +00:00
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/LogEntry"
}
}
2023-06-03 19:38:36 +00:00
}
}
}
} ,
2024-04-14 23:50:50 +00:00
"/repos/{repo_id}/logs/{number}/{stepId}" : {
"delete" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Pipeline logs"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Delete step logs of a pipeline" ,
2024-04-14 23:50:50 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the number of the pipeline" ,
"name" : "number" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the step id" ,
"name" : "stepId" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"description" : "No Content"
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/move" : {
2023-06-03 19:38:36 +00:00
"post" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Repositories"
] ,
"summary" : "Move a repository to a new owner" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the username to move the repository to" ,
"name" : "to" ,
"in" : "query" ,
"required" : true
}
] ,
"responses" : {
2023-10-28 11:37:54 +00:00
"204" : {
"description" : "No Content"
2023-06-03 19:38:36 +00:00
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/permissions" : {
2023-06-03 19:38:36 +00:00
"get" : {
"description" : "The repository permission, according to the used access token." ,
"produces" : [
"application/json"
] ,
"tags" : [
"Repositories"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Check current authenticated users access to the repository" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-12-24 14:50:01 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Perm"
}
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/pipelines" : {
2023-06-03 19:38:36 +00:00
"get" : {
2024-05-01 09:50:41 +00:00
"description" : "Get a list of pipelines for a repository." ,
2023-06-03 19:38:36 +00:00
"produces" : [
"application/json"
] ,
"tags" : [
"Pipelines"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "List repository pipelines" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"default" : 1 ,
"description" : "for response pagination, page offset number" ,
"name" : "page" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"default" : 50 ,
"description" : "for response pagination, max items per page" ,
"name" : "perPage" ,
"in" : "query"
2024-04-25 07:37:42 +00:00
} ,
{
"type" : "string" ,
"description" : "only return pipelines before this RFC3339 date" ,
"name" : "before" ,
"in" : "query"
} ,
{
"type" : "string" ,
"description" : "only return pipelines after this RFC3339 date" ,
"name" : "after" ,
"in" : "query"
2023-06-03 19:38:36 +00:00
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Pipeline"
}
}
}
}
} ,
"post" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Pipelines"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Trigger a manual pipeline" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"description" : "the options for the pipeline to run" ,
"name" : "options" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/PipelineOptions"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Pipeline"
}
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/pipelines/{number}" : {
2023-06-03 19:38:36 +00:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Pipelines"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Get a repositories pipeline" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the number of the pipeline, OR 'latest'" ,
"name" : "number" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Pipeline"
}
}
}
} ,
"post" : {
"description" : "Restarts a pipeline optional with altered event, deploy or environment" ,
"produces" : [
"application/json"
] ,
"tags" : [
"Pipelines"
] ,
"summary" : "Restart a pipeline" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-12-24 14:50:01 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the number of the pipeline" ,
"name" : "number" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "override the event type" ,
"name" : "event" ,
"in" : "query"
} ,
{
"type" : "string" ,
"description" : "override the target deploy value" ,
"name" : "deploy_to" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Pipeline"
}
}
}
2024-04-25 08:59:17 +00:00
} ,
"delete" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Pipelines"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Delete a pipeline" ,
2024-04-25 08:59:17 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the number of the pipeline" ,
"name" : "number" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"204" : {
"description" : "No Content"
}
}
2023-06-03 19:38:36 +00:00
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/pipelines/{number}/approve" : {
2023-06-03 19:38:36 +00:00
"post" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Pipelines"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Approve and start a pipeline" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the number of the pipeline" ,
"name" : "number" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Pipeline"
}
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/pipelines/{number}/cancel" : {
2023-06-03 19:38:36 +00:00
"post" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Pipelines"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Cancel a pipeline" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the number of the pipeline" ,
"name" : "number" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/pipelines/{number}/config" : {
2023-06-03 19:38:36 +00:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Pipelines"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Get configuration files for a pipeline" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the number of the pipeline" ,
"name" : "number" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Config"
}
}
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/pipelines/{number}/decline" : {
2023-06-03 19:38:36 +00:00
"post" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Pipelines"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Decline a pipeline" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the number of the pipeline" ,
"name" : "number" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Pipeline"
}
}
}
}
} ,
2024-09-25 05:20:51 +00:00
"/repos/{repo_id}/pipelines/{number}/metadata" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Pipelines"
] ,
"summary" : "Get metadata for a pipeline or a specific workflow, including previous pipeline info" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the number of the pipeline" ,
"name" : "number" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/metadata.Metadata"
}
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/pull_requests" : {
2023-06-03 19:38:36 +00:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repositories"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "List active pull requests of a repository" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"default" : 1 ,
"description" : "for response pagination, page offset number" ,
"name" : "page" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"default" : 50 ,
"description" : "for response pagination, max items per page" ,
"name" : "perPage" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/PullRequest"
}
}
}
}
}
} ,
2024-07-03 13:33:11 +00:00
"/repos/{repo_id}/registries" : {
2023-06-03 19:38:36 +00:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repository registries"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "List registries" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"default" : 1 ,
"description" : "for response pagination, page offset number" ,
"name" : "page" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"default" : 50 ,
"description" : "for response pagination, max items per page" ,
"name" : "perPage" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Registry"
}
}
}
}
} ,
"post" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repository registries"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Create a registry" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"description" : "the new registry data" ,
"name" : "registry" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Registry"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Registry"
}
}
}
}
} ,
2024-07-03 13:33:11 +00:00
"/repos/{repo_id}/registries/{registry}" : {
2023-06-03 19:38:36 +00:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repository registries"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Get a registry by name" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the registry name" ,
"name" : "registry" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Registry"
}
}
}
} ,
"delete" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Repository registries"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Delete a registry by name" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the registry name" ,
"name" : "registry" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
2023-09-02 11:31:10 +00:00
"204" : {
"description" : "No Content"
2023-06-03 19:38:36 +00:00
}
}
} ,
"patch" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repository registries"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Update a registry by name" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the registry name" ,
"name" : "registry" ,
"in" : "path" ,
"required" : true
} ,
{
"description" : "the attributes for the registry" ,
"name" : "registryData" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Registry"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Registry"
}
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/repair" : {
2023-06-03 19:38:36 +00:00
"post" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Repositories"
] ,
"summary" : "Repair a repository" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
2023-10-24 12:12:55 +00:00
"204" : {
"description" : "No Content"
2023-06-03 19:38:36 +00:00
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/secrets" : {
2023-06-03 19:38:36 +00:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repository secrets"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "List repository secrets" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"default" : 1 ,
"description" : "for response pagination, page offset number" ,
"name" : "page" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"default" : 50 ,
"description" : "for response pagination, max items per page" ,
"name" : "perPage" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Secret"
}
}
}
}
} ,
"post" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repository secrets"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Create a repository secret" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"description" : "the new secret" ,
"name" : "secret" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Secret"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Secret"
}
}
}
}
} ,
2023-06-12 23:07:52 +00:00
"/repos/{repo_id}/secrets/{secretName}" : {
2023-06-03 19:38:36 +00:00
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repository secrets"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Get a repository secret by name" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the secret name" ,
"name" : "secretName" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Secret"
}
}
}
} ,
"delete" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Repository secrets"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Delete a repository secret by name" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the secret name" ,
"name" : "secretName" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
2023-08-05 17:44:49 +00:00
"204" : {
"description" : "No Content"
2023-06-03 19:38:36 +00:00
}
}
} ,
"patch" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Repository secrets"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Update a repository secret by name" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
2023-06-12 23:07:52 +00:00
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
2023-06-03 19:38:36 +00:00
"in" : "path" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the secret name" ,
"name" : "secretName" ,
"in" : "path" ,
"required" : true
} ,
{
"description" : "the secret itself" ,
"name" : "secret" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Secret"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Secret"
}
}
}
}
} ,
"/secrets" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Secrets"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "List global secrets" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"default" : 1 ,
"description" : "for response pagination, page offset number" ,
"name" : "page" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"default" : 50 ,
"description" : "for response pagination, max items per page" ,
"name" : "perPage" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Secret"
}
}
}
}
} ,
"post" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Secrets"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Create a global secret" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"description" : "the secret object data" ,
"name" : "secret" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Secret"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Secret"
}
}
}
}
} ,
"/secrets/{secret}" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Secrets"
] ,
"summary" : "Get a global secret by name" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the secret's name" ,
"name" : "secret" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Secret"
}
}
}
} ,
"delete" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Secrets"
] ,
"summary" : "Delete a global secret by name" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the secret's name" ,
"name" : "secret" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
2023-08-05 17:44:49 +00:00
"204" : {
"description" : "No Content"
2023-06-03 19:38:36 +00:00
}
}
} ,
"patch" : {
"produces" : [
"application/json"
] ,
"tags" : [
"Secrets"
] ,
"summary" : "Update a global secret by name" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the secret's name" ,
"name" : "secret" ,
"in" : "path" ,
"required" : true
} ,
{
"description" : "the secret's data" ,
"name" : "secretData" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/Secret"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/Secret"
}
}
}
}
} ,
"/signature/public-key" : {
"get" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"System"
] ,
"summary" : "Get server's signature public key" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK"
2023-10-24 13:21:05 +00:00
}
}
}
} ,
"/stream/events" : {
"get" : {
2024-05-01 09:50:41 +00:00
"description" : "With quic and http2 support" ,
2023-10-24 13:21:05 +00:00
"produces" : [
"text/plain"
] ,
"tags" : [
"Events"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Stream events like pipeline updates" ,
2023-10-24 13:21:05 +00:00
"responses" : {
"200" : {
"description" : "OK"
}
}
}
} ,
"/stream/logs/{repo_id}/{pipeline}/{stepID}" : {
"get" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"Pipeline logs"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Stream logs of a pipeline step" ,
2023-10-24 13:21:05 +00:00
"parameters" : [
{
"type" : "integer" ,
"description" : "the repository id" ,
"name" : "repo_id" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the number of the pipeline" ,
"name" : "pipeline" ,
"in" : "path" ,
"required" : true
} ,
{
"type" : "integer" ,
"description" : "the step id" ,
"name" : "stepID" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK"
2023-06-03 19:38:36 +00:00
}
}
}
} ,
"/user" : {
"get" : {
"produces" : [
"application/json"
] ,
"tags" : [
"User"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Get the currently authenticated user" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/User"
}
}
}
}
} ,
"/user/feed" : {
"get" : {
2024-05-01 09:50:41 +00:00
"description" : "The feed lists the most recent pipeline for the currently authenticated user." ,
2023-06-03 19:38:36 +00:00
"produces" : [
"application/json"
] ,
"tags" : [
"User"
] ,
2024-05-31 13:57:57 +00:00
"summary" : "Get the currently authenticated users pipeline feed" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
2024-05-01 09:50:41 +00:00
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Feed"
}
2023-06-03 19:38:36 +00:00
}
}
}
}
} ,
"/user/repos" : {
"get" : {
"description" : "Retrieve the currently authenticated User's Repository list" ,
"produces" : [
"application/json"
] ,
"tags" : [
"User"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Get user's repositories" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
2023-07-11 16:51:03 +00:00
} ,
{
"type" : "boolean" ,
2023-07-12 11:49:18 +00:00
"description" : "query all repos, including inactive ones" ,
2023-07-11 16:51:03 +00:00
"name" : "all" ,
"in" : "query"
2023-06-03 19:38:36 +00:00
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Repo"
}
}
}
}
}
} ,
"/user/token" : {
"post" : {
"produces" : [
"text/plain"
] ,
"tags" : [
"User"
] ,
2023-09-02 11:31:10 +00:00
"summary" : "Return the token of the current user as string" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
} ,
"delete" : {
"description" : "Reset's the current personal access token of the user and returns a new one." ,
"produces" : [
"text/plain"
] ,
"tags" : [
"User"
] ,
"summary" : "Reset a token" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK"
}
}
}
} ,
"/users" : {
"get" : {
"description" : "Returns all registered, active users in the system. Requires admin rights." ,
"produces" : [
"application/json"
] ,
"tags" : [
"Users"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "List users" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "integer" ,
"default" : 1 ,
"description" : "for response pagination, page offset number" ,
"name" : "page" ,
"in" : "query"
} ,
{
"type" : "integer" ,
"default" : 50 ,
"description" : "for response pagination, max items per page" ,
"name" : "perPage" ,
"in" : "query"
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/User"
}
}
}
}
} ,
"post" : {
"description" : "Creates a new user account with the specified external login. Requires admin rights." ,
"produces" : [
"application/json"
] ,
"tags" : [
"Users"
] ,
"summary" : "Create a user" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"description" : "the user's data" ,
"name" : "user" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/User"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/User"
}
}
}
}
} ,
"/users/{login}" : {
"get" : {
"description" : "Returns a user with the specified login name. Requires admin rights." ,
"produces" : [
"application/json"
] ,
"tags" : [
"Users"
] ,
"summary" : "Get a user" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the user's login name" ,
"name" : "login" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/User"
}
}
}
} ,
"delete" : {
"description" : "Deletes the given user. Requires admin rights." ,
"produces" : [
2023-09-02 11:31:10 +00:00
"text/plain"
2023-06-03 19:38:36 +00:00
] ,
"tags" : [
"Users"
] ,
"summary" : "Delete a user" ,
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the user's login name" ,
"name" : "login" ,
"in" : "path" ,
"required" : true
}
] ,
"responses" : {
2023-09-02 11:31:10 +00:00
"204" : {
"description" : "No Content"
2023-06-03 19:38:36 +00:00
}
}
} ,
"patch" : {
"description" : "Changes the data of an existing user. Requires admin rights." ,
"consumes" : [
"application/json"
] ,
"produces" : [
"application/json"
] ,
"tags" : [
"Users"
] ,
2024-05-01 09:50:41 +00:00
"summary" : "Update a user" ,
2023-06-03 19:38:36 +00:00
"parameters" : [
{
"type" : "string" ,
"default" : "Bearer \u003cpersonal access token\u003e" ,
"description" : "Insert your personal access token" ,
"name" : "Authorization" ,
"in" : "header" ,
"required" : true
} ,
{
"type" : "string" ,
"description" : "the user's login name" ,
"name" : "login" ,
"in" : "path" ,
"required" : true
} ,
{
"description" : "the user's data" ,
"name" : "user" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/User"
}
}
] ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"$ref" : "#/definitions/User"
}
}
}
}
} ,
"/version" : {
"get" : {
"description" : "Endpoint returns the server version and build information." ,
"produces" : [
"application/json"
] ,
"tags" : [
"System"
] ,
"summary" : "Get version" ,
"responses" : {
"200" : {
"description" : "OK" ,
"schema" : {
"allOf" : [
{
"type" : "string"
} ,
{
"type" : "object" ,
"properties" : {
"source" : {
"type" : "string"
} ,
"version" : {
"type" : "string"
}
}
}
]
}
}
}
}
}
} ,
"definitions" : {
"Agent" : {
"type" : "object" ,
"properties" : {
"backend" : {
"type" : "string"
} ,
"capacity" : {
"type" : "integer"
} ,
"created" : {
"type" : "integer"
} ,
2024-10-06 15:13:41 +00:00
"custom_labels" : {
"type" : "object" ,
"additionalProperties" : {
"type" : "string"
}
} ,
2023-06-03 19:38:36 +00:00
"id" : {
"type" : "integer"
} ,
"last_contact" : {
"type" : "integer"
} ,
2024-07-01 17:34:47 +00:00
"last_work" : {
"description" : "last time the agent did something, this value is used to determine if the agent is still doing work used by the autoscaler" ,
"type" : "integer"
} ,
2023-06-03 19:38:36 +00:00
"name" : {
"type" : "string"
} ,
"no_schedule" : {
"type" : "boolean"
} ,
2024-09-30 11:33:16 +00:00
"org_id" : {
"description" : "OrgID is counted as unset if set to -1, this is done to ensure a new(Agent) still enforce the OrgID check by default" ,
"type" : "integer"
} ,
2023-06-03 19:38:36 +00:00
"owner_id" : {
"type" : "integer"
} ,
"platform" : {
"type" : "string"
} ,
"token" : {
"type" : "string"
} ,
"updated" : {
"type" : "integer"
} ,
"version" : {
"type" : "string"
}
}
} ,
"Config" : {
"type" : "object" ,
"properties" : {
"data" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
} ,
"hash" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
}
}
} ,
"Cron" : {
"type" : "object" ,
"properties" : {
"branch" : {
"type" : "string"
} ,
2024-08-07 08:49:03 +00:00
"created" : {
2023-06-03 19:38:36 +00:00
"type" : "integer"
} ,
"creator_id" : {
"type" : "integer"
} ,
"id" : {
"type" : "integer"
} ,
"name" : {
"type" : "string"
} ,
"next_exec" : {
"type" : "integer"
} ,
"repo_id" : {
"type" : "integer"
} ,
"schedule" : {
"description" : "@weekly,\t3min, ..." ,
"type" : "string"
}
}
} ,
"Feed" : {
"type" : "object" ,
"properties" : {
"author" : {
"type" : "string"
} ,
"author_avatar" : {
"type" : "string"
} ,
"author_email" : {
"type" : "string"
} ,
"branch" : {
"type" : "string"
} ,
"commit" : {
"type" : "string"
} ,
2024-08-07 08:49:03 +00:00
"created" : {
2023-06-03 19:38:36 +00:00
"type" : "integer"
} ,
"event" : {
"type" : "string"
} ,
2024-08-07 08:49:03 +00:00
"finished" : {
2023-06-03 19:38:36 +00:00
"type" : "integer"
} ,
"id" : {
"type" : "integer"
} ,
"message" : {
"type" : "string"
} ,
"number" : {
"type" : "integer"
} ,
"ref" : {
"type" : "string"
} ,
"refspec" : {
"type" : "string"
} ,
2023-06-12 23:07:52 +00:00
"repo_id" : {
"type" : "integer"
} ,
2024-08-07 08:49:03 +00:00
"started" : {
2023-06-03 19:38:36 +00:00
"type" : "integer"
} ,
"status" : {
"type" : "string"
} ,
"title" : {
"type" : "string"
}
}
} ,
2024-06-20 11:08:54 +00:00
"Forge" : {
"type" : "object" ,
"properties" : {
"additional_options" : {
"type" : "object" ,
"additionalProperties" : { }
} ,
"client" : {
"type" : "string"
} ,
"id" : {
"type" : "integer"
} ,
"oauth_host" : {
"description" : "public url for oauth if different from url" ,
"type" : "string"
} ,
"skip_verify" : {
"type" : "boolean"
} ,
"type" : {
"$ref" : "#/definitions/model.ForgeType"
} ,
"url" : {
"type" : "string"
}
}
} ,
2023-06-06 07:52:08 +00:00
"LogEntry" : {
"type" : "object" ,
"properties" : {
"data" : {
"type" : "array" ,
"items" : {
"type" : "integer"
}
} ,
"id" : {
"type" : "integer"
} ,
"line" : {
"type" : "integer"
} ,
"step_id" : {
"type" : "integer"
} ,
"time" : {
"type" : "integer"
} ,
"type" : {
2023-09-01 14:44:55 +00:00
"$ref" : "#/definitions/LogEntryType"
2023-06-06 07:52:08 +00:00
}
}
} ,
2023-09-01 14:44:55 +00:00
"LogEntryType" : {
"type" : "integer" ,
"enum" : [
0 ,
1 ,
2 ,
3 ,
4
] ,
"x-enum-varnames" : [
"LogEntryStdout" ,
"LogEntryStderr" ,
"LogEntryExitCode" ,
"LogEntryMetadata" ,
"LogEntryProgress"
]
} ,
2023-07-21 17:45:32 +00:00
"Org" : {
"type" : "object" ,
"properties" : {
2024-04-16 06:04:55 +00:00
"forge_id" : {
"type" : "integer"
} ,
2023-07-21 17:45:32 +00:00
"id" : {
"type" : "integer"
} ,
"is_user" : {
"type" : "boolean"
} ,
"name" : {
"type" : "string"
}
}
} ,
2023-06-03 19:38:36 +00:00
"OrgPerm" : {
"type" : "object" ,
"properties" : {
"admin" : {
"type" : "boolean"
} ,
"member" : {
"type" : "boolean"
}
}
} ,
"Perm" : {
"type" : "object" ,
"properties" : {
"admin" : {
"type" : "boolean"
} ,
"created" : {
"type" : "integer"
} ,
"pull" : {
"type" : "boolean"
} ,
"push" : {
"type" : "boolean"
} ,
"synced" : {
"type" : "integer"
} ,
"updated" : {
"type" : "integer"
}
}
} ,
"Pipeline" : {
"type" : "object" ,
"properties" : {
"author" : {
"type" : "string"
} ,
"author_avatar" : {
"type" : "string"
} ,
"author_email" : {
"type" : "string"
} ,
"branch" : {
"type" : "string"
} ,
"changed_files" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"commit" : {
"type" : "string"
} ,
2024-08-07 08:49:03 +00:00
"created" : {
2023-06-03 19:38:36 +00:00
"type" : "integer"
} ,
2024-05-02 16:56:19 +00:00
"deploy_task" : {
"type" : "string"
} ,
2023-06-03 19:38:36 +00:00
"deploy_to" : {
"type" : "string"
} ,
2023-11-03 10:44:03 +00:00
"errors" : {
"type" : "array" ,
"items" : {
2024-04-15 08:04:21 +00:00
"$ref" : "#/definitions/types.PipelineError"
2023-11-03 10:44:03 +00:00
}
2023-06-03 19:38:36 +00:00
} ,
"event" : {
"$ref" : "#/definitions/WebhookEvent"
} ,
2024-08-07 08:49:03 +00:00
"finished" : {
2023-06-03 19:38:36 +00:00
"type" : "integer"
} ,
2023-11-14 16:12:12 +00:00
"forge_url" : {
"type" : "string"
} ,
2024-11-18 13:49:12 +00:00
"from_fork" : {
"type" : "boolean"
} ,
2023-06-03 19:38:36 +00:00
"id" : {
"type" : "integer"
} ,
2024-01-30 16:39:00 +00:00
"is_prerelease" : {
"type" : "boolean"
} ,
2023-06-03 19:38:36 +00:00
"message" : {
"type" : "string"
} ,
"number" : {
"type" : "integer"
} ,
"parent" : {
"type" : "integer"
} ,
"pr_labels" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"ref" : {
"type" : "string"
} ,
"refspec" : {
"type" : "string"
} ,
2024-08-07 08:49:03 +00:00
"reviewed" : {
2023-06-03 19:38:36 +00:00
"type" : "integer"
} ,
"reviewed_by" : {
"type" : "string"
} ,
"sender" : {
"description" : "uses reported user for webhooks and name of cron for cron pipelines" ,
"type" : "string"
} ,
2024-08-07 08:49:03 +00:00
"started" : {
2023-06-03 19:38:36 +00:00
"type" : "integer"
} ,
"status" : {
"$ref" : "#/definitions/StatusValue"
} ,
"timestamp" : {
"type" : "integer"
} ,
"title" : {
"type" : "string"
} ,
2024-08-07 08:49:03 +00:00
"updated" : {
2023-06-03 19:38:36 +00:00
"type" : "integer"
} ,
"variables" : {
"type" : "object" ,
"additionalProperties" : {
"type" : "string"
}
2023-06-27 16:01:18 +00:00
} ,
"workflows" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/model.Workflow"
}
2023-06-03 19:38:36 +00:00
}
}
} ,
"PipelineOptions" : {
"type" : "object" ,
"properties" : {
"branch" : {
"type" : "string"
} ,
"variables" : {
"type" : "object" ,
"additionalProperties" : {
"type" : "string"
}
}
}
} ,
"PullRequest" : {
"type" : "object" ,
"properties" : {
"index" : {
2023-11-25 23:52:52 +00:00
"type" : "string"
2023-06-03 19:38:36 +00:00
} ,
"title" : {
"type" : "string"
}
}
} ,
"Registry" : {
"type" : "object" ,
"properties" : {
"address" : {
"type" : "string"
} ,
"id" : {
"type" : "integer"
} ,
2024-07-03 13:33:11 +00:00
"org_id" : {
"type" : "integer"
} ,
2023-06-03 19:38:36 +00:00
"password" : {
"type" : "string"
} ,
2024-07-03 13:33:11 +00:00
"readonly" : {
"type" : "boolean"
} ,
"repo_id" : {
"type" : "integer"
} ,
2023-06-03 19:38:36 +00:00
"username" : {
"type" : "string"
}
}
} ,
"Repo" : {
"type" : "object" ,
"properties" : {
"active" : {
"type" : "boolean"
} ,
2024-04-02 20:03:37 +00:00
"allow_deploy" : {
"type" : "boolean"
} ,
2023-06-03 19:38:36 +00:00
"allow_pr" : {
"type" : "boolean"
} ,
"avatar_url" : {
"type" : "string"
} ,
"cancel_previous_pipeline_events" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/WebhookEvent"
}
} ,
"clone_url" : {
"type" : "string"
} ,
2023-08-12 15:39:13 +00:00
"clone_url_ssh" : {
"type" : "string"
} ,
2023-06-03 19:38:36 +00:00
"config_file" : {
"type" : "string"
} ,
"default_branch" : {
"type" : "string"
} ,
2024-04-16 06:04:55 +00:00
"forge_id" : {
"type" : "integer"
} ,
2023-06-12 23:07:52 +00:00
"forge_remote_id" : {
"description" : "ForgeRemoteID is the unique identifier for the repository on the forge." ,
"type" : "string"
} ,
2023-11-14 16:12:12 +00:00
"forge_url" : {
"type" : "string"
} ,
2023-06-03 19:38:36 +00:00
"full_name" : {
"type" : "string"
} ,
"id" : {
"type" : "integer"
} ,
"name" : {
"type" : "string"
} ,
"netrc_only_trusted" : {
"type" : "boolean"
} ,
2023-07-21 17:45:32 +00:00
"org_id" : {
"type" : "integer"
} ,
2023-06-03 19:38:36 +00:00
"owner" : {
"type" : "string"
} ,
2023-12-24 09:04:18 +00:00
"pr_enabled" : {
"type" : "boolean"
} ,
2023-06-03 19:38:36 +00:00
"private" : {
"type" : "boolean"
} ,
2024-11-18 13:49:12 +00:00
"require_approval" : {
"$ref" : "#/definitions/model.ApprovalMode"
} ,
2023-06-03 19:38:36 +00:00
"scm" : {
"$ref" : "#/definitions/SCMKind"
} ,
"timeout" : {
"type" : "integer"
} ,
"trusted" : {
2024-11-01 20:37:31 +00:00
"$ref" : "#/definitions/model.TrustedConfiguration"
2023-06-03 19:38:36 +00:00
} ,
"visibility" : {
"$ref" : "#/definitions/RepoVisibility"
}
}
} ,
"RepoPatch" : {
"type" : "object" ,
"properties" : {
2024-04-02 20:03:37 +00:00
"allow_deploy" : {
"type" : "boolean"
} ,
2023-06-03 19:38:36 +00:00
"allow_pr" : {
"type" : "boolean"
} ,
"cancel_previous_pipeline_events" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/WebhookEvent"
}
} ,
"config_file" : {
"type" : "string"
} ,
"gated" : {
2024-11-18 13:49:12 +00:00
"description" : "TODO: deprecated in favor of RequireApproval =\u003e Remove in next major release" ,
2023-06-03 19:38:36 +00:00
"type" : "boolean"
} ,
"netrc_only_trusted" : {
"type" : "boolean"
} ,
2024-11-18 13:49:12 +00:00
"require_approval" : {
"type" : "string"
} ,
2023-06-03 19:38:36 +00:00
"timeout" : {
"type" : "integer"
} ,
"trusted" : {
2024-11-01 20:37:31 +00:00
"$ref" : "#/definitions/model.TrustedConfigurationPatch"
2023-06-03 19:38:36 +00:00
} ,
"visibility" : {
"type" : "string"
}
}
} ,
"RepoVisibility" : {
"type" : "string" ,
"enum" : [
"public" ,
"private" ,
"internal"
] ,
"x-enum-varnames" : [
"VisibilityPublic" ,
"VisibilityPrivate" ,
"VisibilityInternal"
]
} ,
"SCMKind" : {
"type" : "string" ,
"enum" : [
"git" ,
"hg" ,
"fossil" ,
"perforce"
] ,
"x-enum-varnames" : [
"RepoGit" ,
"RepoHg" ,
"RepoFossil" ,
"RepoPerforce"
]
} ,
"Secret" : {
"type" : "object" ,
"properties" : {
2023-10-24 18:38:47 +00:00
"events" : {
2023-06-03 19:38:36 +00:00
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/WebhookEvent"
}
} ,
"id" : {
"type" : "integer"
} ,
2023-10-24 18:38:47 +00:00
"images" : {
2023-06-03 19:38:36 +00:00
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"name" : {
"type" : "string"
} ,
2023-12-16 09:29:13 +00:00
"org_id" : {
"type" : "integer"
} ,
"repo_id" : {
"type" : "integer"
} ,
2023-06-03 19:38:36 +00:00
"value" : {
"type" : "string"
}
}
} ,
"StatusValue" : {
"type" : "string" ,
"enum" : [
"skipped" ,
"pending" ,
"running" ,
"success" ,
"failure" ,
"killed" ,
"error" ,
"blocked" ,
2023-12-12 20:30:52 +00:00
"declined" ,
"created"
2023-06-03 19:38:36 +00:00
] ,
2023-11-03 10:44:03 +00:00
"x-enum-comments" : {
"StatusBlocked" : "waiting for approval" ,
2023-12-12 20:30:52 +00:00
"StatusCreated" : "created / internal use only" ,
2023-11-03 10:44:03 +00:00
"StatusDeclined" : "blocked and declined" ,
"StatusError" : "error with the config / while parsing / some other system problem" ,
"StatusFailure" : "failed to finish (exit code != 0)" ,
"StatusKilled" : "killed by user" ,
"StatusPending" : "pending to be executed" ,
"StatusRunning" : "currently running" ,
"StatusSkipped" : "skipped as another step failed" ,
"StatusSuccess" : "successfully finished"
} ,
2023-06-03 19:38:36 +00:00
"x-enum-varnames" : [
"StatusSkipped" ,
"StatusPending" ,
"StatusRunning" ,
"StatusSuccess" ,
"StatusFailure" ,
"StatusKilled" ,
"StatusError" ,
"StatusBlocked" ,
2023-12-12 20:30:52 +00:00
"StatusDeclined" ,
"StatusCreated"
2023-06-03 19:38:36 +00:00
]
} ,
"Step" : {
"type" : "object" ,
"properties" : {
"error" : {
"type" : "string"
} ,
"exit_code" : {
"type" : "integer"
} ,
2024-08-07 08:49:03 +00:00
"finished" : {
"type" : "integer"
} ,
2023-06-03 19:38:36 +00:00
"id" : {
"type" : "integer"
} ,
"name" : {
"type" : "string"
} ,
"pid" : {
"type" : "integer"
} ,
"pipeline_id" : {
"type" : "integer"
} ,
"ppid" : {
"type" : "integer"
} ,
2024-08-07 08:49:03 +00:00
"started" : {
2023-06-03 19:38:36 +00:00
"type" : "integer"
} ,
"state" : {
"$ref" : "#/definitions/StatusValue"
2023-06-06 07:52:08 +00:00
} ,
2023-07-11 13:53:05 +00:00
"type" : {
"$ref" : "#/definitions/StepType"
} ,
2023-06-06 07:52:08 +00:00
"uuid" : {
"type" : "string"
2023-06-03 19:38:36 +00:00
}
}
} ,
2023-07-11 13:53:05 +00:00
"StepType" : {
"type" : "string" ,
"enum" : [
"clone" ,
"service" ,
"plugin" ,
"commands" ,
"cache"
] ,
"x-enum-varnames" : [
"StepTypeClone" ,
"StepTypeService" ,
"StepTypePlugin" ,
"StepTypeCommands" ,
"StepTypeCache"
]
} ,
2023-06-03 19:38:36 +00:00
"Task" : {
"type" : "object" ,
"properties" : {
"agent_id" : {
"type" : "integer"
} ,
"dep_status" : {
"type" : "object" ,
"additionalProperties" : {
"$ref" : "#/definitions/StatusValue"
}
} ,
"dependencies" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"id" : {
"type" : "string"
} ,
"labels" : {
"type" : "object" ,
"additionalProperties" : {
"type" : "string"
}
} ,
"run_on" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
} ,
"User" : {
"type" : "object" ,
"properties" : {
"admin" : {
2023-10-08 12:05:06 +00:00
"description" : "Admin indicates the user is a system administrator.\n\nNOTE: If the username is part of the WOODPECKER_ADMIN\nenvironment variable, this value will be set to true on login." ,
2023-06-03 19:38:36 +00:00
"type" : "boolean"
} ,
"avatar_url" : {
"description" : "the avatar url for this user." ,
"type" : "string"
} ,
"email" : {
"description" : "Email is the email address for this user.\n\nrequired: true" ,
"type" : "string"
} ,
2024-04-16 06:04:55 +00:00
"forge_id" : {
"type" : "integer"
} ,
2023-06-03 19:38:36 +00:00
"id" : {
"description" : "the id for this user.\n\nrequired: true" ,
"type" : "integer"
} ,
"login" : {
"description" : "Login is the username for this user.\n\nrequired: true" ,
"type" : "string"
2023-08-21 13:04:12 +00:00
} ,
"org_id" : {
"description" : "OrgID is the of the user as model.Org." ,
"type" : "integer"
2023-06-03 19:38:36 +00:00
}
}
} ,
"WebhookEvent" : {
"type" : "string" ,
"enum" : [
"push" ,
"pull_request" ,
2023-12-26 18:22:52 +00:00
"pull_request_closed" ,
2023-06-03 19:38:36 +00:00
"tag" ,
2024-01-30 16:39:00 +00:00
"release" ,
2023-06-03 19:38:36 +00:00
"deployment" ,
"cron" ,
"manual"
] ,
"x-enum-varnames" : [
"EventPush" ,
"EventPull" ,
2023-12-26 18:22:52 +00:00
"EventPullClosed" ,
2023-06-03 19:38:36 +00:00
"EventTag" ,
2024-01-30 16:39:00 +00:00
"EventRelease" ,
2023-06-03 19:38:36 +00:00
"EventDeploy" ,
"EventCron" ,
"EventManual"
]
2023-06-06 07:52:08 +00:00
} ,
2024-09-25 05:20:51 +00:00
"metadata.Author" : {
"type" : "object" ,
"properties" : {
"avatar" : {
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
}
}
} ,
"metadata.Commit" : {
"type" : "object" ,
"properties" : {
"author" : {
"$ref" : "#/definitions/metadata.Author"
} ,
"branch" : {
"type" : "string"
} ,
"changed_files" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"is_prerelease" : {
"type" : "boolean"
} ,
"labels" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"message" : {
"type" : "string"
} ,
"ref" : {
"type" : "string"
} ,
"refspec" : {
"type" : "string"
} ,
"sha" : {
"type" : "string"
}
}
} ,
"metadata.Forge" : {
"type" : "object" ,
"properties" : {
"type" : {
"type" : "string"
} ,
"url" : {
"type" : "string"
}
}
} ,
"metadata.Metadata" : {
"type" : "object" ,
"properties" : {
"curr" : {
"$ref" : "#/definitions/metadata.Pipeline"
} ,
"forge" : {
"$ref" : "#/definitions/metadata.Forge"
} ,
"id" : {
"type" : "string"
} ,
"prev" : {
"$ref" : "#/definitions/metadata.Pipeline"
} ,
"repo" : {
"$ref" : "#/definitions/metadata.Repo"
} ,
"step" : {
"$ref" : "#/definitions/metadata.Step"
} ,
"sys" : {
"$ref" : "#/definitions/metadata.System"
} ,
"workflow" : {
"$ref" : "#/definitions/metadata.Workflow"
}
}
} ,
"metadata.Pipeline" : {
"type" : "object" ,
"properties" : {
"commit" : {
"$ref" : "#/definitions/metadata.Commit"
} ,
"created" : {
"type" : "integer"
} ,
"cron" : {
"type" : "string"
} ,
"event" : {
"type" : "string"
} ,
"finished" : {
"type" : "integer"
} ,
"forge_url" : {
"type" : "string"
} ,
"number" : {
"type" : "integer"
} ,
"parent" : {
"type" : "integer"
} ,
"started" : {
"type" : "integer"
} ,
"status" : {
"type" : "string"
} ,
"target" : {
"type" : "string"
} ,
"task" : {
"type" : "string"
}
}
} ,
"metadata.Repo" : {
"type" : "object" ,
"properties" : {
"clone_url" : {
"type" : "string"
} ,
"clone_url_ssh" : {
"type" : "string"
} ,
"default_branch" : {
"type" : "string"
} ,
"forge_url" : {
"type" : "string"
} ,
"id" : {
"type" : "integer"
} ,
"name" : {
"type" : "string"
} ,
"owner" : {
"type" : "string"
} ,
"private" : {
"type" : "boolean"
} ,
"remote_id" : {
"type" : "string"
} ,
"scm" : {
"type" : "string"
} ,
"trusted" : {
2024-11-01 20:37:31 +00:00
"$ref" : "#/definitions/metadata.TrustedConfiguration"
2024-09-25 05:20:51 +00:00
}
}
} ,
"metadata.Step" : {
"type" : "object" ,
"properties" : {
"name" : {
"type" : "string"
} ,
"number" : {
"type" : "integer"
}
}
} ,
"metadata.System" : {
"type" : "object" ,
"properties" : {
"arch" : {
"type" : "string"
} ,
"host" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"url" : {
"type" : "string"
} ,
"version" : {
"type" : "string"
}
}
} ,
2024-11-01 20:37:31 +00:00
"metadata.TrustedConfiguration" : {
"type" : "object" ,
"properties" : {
"network" : {
"type" : "boolean"
} ,
"security" : {
"type" : "boolean"
} ,
"volumes" : {
"type" : "boolean"
}
}
} ,
2024-09-25 05:20:51 +00:00
"metadata.Workflow" : {
"type" : "object" ,
"properties" : {
"matrix" : {
"type" : "object" ,
"additionalProperties" : {
"type" : "string"
}
} ,
"name" : {
"type" : "string"
} ,
"number" : {
"type" : "integer"
}
}
} ,
2024-11-18 13:49:12 +00:00
"model.ApprovalMode" : {
"type" : "string" ,
"enum" : [
"none" ,
"forks" ,
"pull_requests" ,
"all_events"
] ,
"x-enum-comments" : {
"RequireApprovalAllEvents" : "require approval for all external events" ,
"RequireApprovalForks" : "require approval for PRs from forks (default)" ,
"RequireApprovalNone" : "require approval for no events" ,
"RequireApprovalPullRequests" : "require approval for all PRs"
} ,
"x-enum-varnames" : [
"RequireApprovalNone" ,
"RequireApprovalForks" ,
"RequireApprovalPullRequests" ,
"RequireApprovalAllEvents"
]
} ,
2024-06-20 11:08:54 +00:00
"model.ForgeType" : {
"type" : "string" ,
"enum" : [
"github" ,
"gitlab" ,
"gitea" ,
"forgejo" ,
"bitbucket" ,
"bitbucket-dc" ,
"addon"
] ,
"x-enum-varnames" : [
"ForgeTypeGithub" ,
"ForgeTypeGitlab" ,
"ForgeTypeGitea" ,
"ForgeTypeForgejo" ,
"ForgeTypeBitbucket" ,
"ForgeTypeBitbucketDatacenter" ,
"ForgeTypeAddon"
]
} ,
2024-11-01 20:37:31 +00:00
"model.TrustedConfiguration" : {
"type" : "object" ,
"properties" : {
"network" : {
"type" : "boolean"
} ,
"security" : {
"type" : "boolean"
} ,
"volumes" : {
"type" : "boolean"
}
}
} ,
"model.TrustedConfigurationPatch" : {
"type" : "object" ,
"properties" : {
"network" : {
"type" : "boolean"
} ,
"security" : {
"type" : "boolean"
} ,
"volumes" : {
"type" : "boolean"
}
}
} ,
2023-06-27 16:01:18 +00:00
"model.Workflow" : {
"type" : "object" ,
"properties" : {
"agent_id" : {
"type" : "integer"
} ,
"children" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/Step"
}
} ,
"environ" : {
"type" : "object" ,
"additionalProperties" : {
"type" : "string"
}
} ,
"error" : {
"type" : "string"
} ,
2024-08-07 08:49:03 +00:00
"finished" : {
"type" : "integer"
} ,
2023-06-27 16:01:18 +00:00
"id" : {
"type" : "integer"
} ,
"name" : {
"type" : "string"
} ,
"pid" : {
"type" : "integer"
} ,
"pipeline_id" : {
"type" : "integer"
} ,
"platform" : {
"type" : "string"
} ,
2024-08-07 08:49:03 +00:00
"started" : {
2023-06-27 16:01:18 +00:00
"type" : "integer"
} ,
"state" : {
"$ref" : "#/definitions/StatusValue"
}
}
2024-04-15 08:04:21 +00:00
} ,
"types.PipelineError" : {
"type" : "object" ,
"properties" : {
"data" : { } ,
"is_warning" : {
"type" : "boolean"
} ,
"message" : {
"type" : "string"
} ,
"type" : {
"$ref" : "#/definitions/types.PipelineErrorType"
}
}
} ,
"types.PipelineErrorType" : {
"type" : "string" ,
"enum" : [
"linter" ,
"deprecation" ,
"compiler" ,
"generic" ,
"bad_habit"
] ,
"x-enum-comments" : {
"PipelineErrorTypeBadHabit" : "some bad-habit error" ,
"PipelineErrorTypeCompiler" : "some error with the config semantics" ,
"PipelineErrorTypeDeprecation" : "using some deprecated feature" ,
"PipelineErrorTypeGeneric" : "some generic error" ,
"PipelineErrorTypeLinter" : "some error with the config syntax"
} ,
"x-enum-varnames" : [
"PipelineErrorTypeLinter" ,
"PipelineErrorTypeDeprecation" ,
"PipelineErrorTypeCompiler" ,
"PipelineErrorTypeGeneric" ,
"PipelineErrorTypeBadHabit"
]
2023-06-03 19:38:36 +00:00
}
}
} `
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = & swag . Spec {
Version : "" ,
Host : "" ,
BasePath : "" ,
Schemes : [ ] string { } ,
Title : "" ,
Description : "" ,
InfoInstanceName : "swagger" ,
SwaggerTemplate : docTemplate ,
LeftDelim : "{{" ,
RightDelim : "}}" ,
}
func init ( ) {
swag . Register ( SwaggerInfo . InstanceName ( ) , SwaggerInfo )
}
