Skip to content

Commit 97cded9

Browse files
Update api.yml
1 parent f52b063 commit 97cded9

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

jekyll/_data/api.yml

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ recent_builds:
195195
196196
build:
197197
url: "/api/v1.1/project/:vcs-type/:username/:project/:build_num"
198-
description: "Full details for a single build. The response includes all of the fields from the build summary."
198+
description: "Full details for a single job. The response includes all of the fields from the job summary."
199199
method: "GET"
200200
response: |
201201
{
@@ -389,6 +389,20 @@ add_user_ssh:
389389
This allows them to SSH to the build containers.
390390
response: '{... the build data ... }'
391391

392+
project_build:
393+
url: "/api/v1.1/project/:vcs-type/:username/:project/build"
394+
description: "Trigger a build of the specified project, by branch / revision or tag. All workflows found in the build configuration will be run."
395+
method: "POST"
396+
params:
397+
- {name: "branch", description: "The branch to build. Cannot be used with tag parameter."}
398+
- {name: "revision", description: "The specific revision to build. If not specified, the HEAD of the branch is used. Cannot be used with tag parameter", note: "Branch and revision can either be used separately or together. If they are used together, the revision is built but the branch is used to display the correct branch on the job page."}
399+
- {name: "tag", description: "The git tag to build. Cannot be used with branch and revision parameters."}
400+
body: |
401+
{
402+
"status": 200,
403+
"body": "Build created"
404+
}
405+
392406
project_branch:
393407
url: "/api/v1.1/project/:vcs-type/:username/:project/tree/:branch"
394408
description: "Triggers a new build, returns a summary of the build."

0 commit comments

Comments
 (0)