diff options
Diffstat (limited to 'builds.sr.ht/api.md')
| -rw-r--r-- | builds.sr.ht/api.md | 86 |
1 files changed, 45 insertions, 41 deletions
diff --git a/builds.sr.ht/api.md b/builds.sr.ht/api.md index 086504e..14385b7 100644 --- a/builds.sr.ht/api.md +++ b/builds.sr.ht/api.md @@ -14,35 +14,37 @@ specified scope. Inserts a new job into the job queue. - { - "manifest": "string", The build manifest - "note": "string", Human-friendly description of this build - (markdown, optional) - "tags": [...], Arbitrary list of strings that identify this - build and can be used to navigate the - dashboard. Each string must use only - lowercase alphanumeric characters, or any - of "-_.:" (optional) - "access:read": [ List of users that have read access to this - job (optional). The user submitting the - build will be included regardless of this - value. The special username "*" indicates - public read access to this build. - Defaults to *. - "string" Username - ], - "access:write": [ List of users that have write access to this - job (optional). The user submitting the - build will be included regardless of this - value. - "string" Username - ], - "triggers": [...], Post-build triggers (optional) - "execute": boolean, True to start the build immediately - (optional - defaults to true) - "secrets": boolean, True to provide secrets during the build - (optional - defaults to true) - } +``` +{ + "manifest": "string", The build manifest + "note": "string", Human-friendly description of this build + (markdown, optional) + "tags": [...], Arbitrary list of strings that identify this + build and can be used to navigate the + dashboard. Each string must use only + lowercase alphanumeric characters, or any + of "-_.:" (optional) + "access:read": [ List of users that have read access to this + job (optional). The user submitting the + build will be included regardless of this + value. The special username "*" indicates + public read access to this build. + Defaults to *. + "string" Username + ], + "access:write": [ List of users that have write access to this + job (optional). The user submitting the + build will be included regardless of this + value. + "string" Username + ], + "triggers": [...], Post-build triggers (optional) + "execute": boolean, True to start the build immediately + (optional - defaults to true) + "secrets": boolean, True to provide secrets during the build + (optional - defaults to true) +} +``` See also: [Build triggers](triggers.md) @@ -52,19 +54,21 @@ Gets information about a job by its ID. **Scopes**: jobs:read +``` +{ + "id": integer, + "status": "job status enum", + "setup_log": "url", URL to captured stdout/stderr of setup + "tasks": [ { - "id": integer, - "status": "job status enum", - "setup_log": "url", URL to captured stdout/stderr of setup - "tasks": [ - { - "name": "setup", - "status": "task status enum" - "log": "url", - }, - ... - ] - } + "name": "setup", + "status": "task status enum" + "log": "url", + }, + ... + ] +} +``` ### Job status enum |