Skip to content

Commit c0536f3

Browse files
authored
docs: add description to branch parameter of createSiteBuild (#604)
1 parent d3d49b4 commit c0536f3

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

go/plumbing/operations/create_site_build_parameters.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

swagger.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1236,7 +1236,10 @@ paths:
12361236
description: 'Runs a build for a site. The build will be scheduled to run at the first opportunity, but it might not start immediately if insufficient account build capacity is available. Files for build could be also uploaded as a zipped site.'
12371237
parameters:
12381238
- name: branch
1239-
description: The branch to build; defaults to main branch
1239+
description: >-
1240+
If no branch is specified, it is treated as a production deploy
1241+
If a branch IS specified and matches the main branch, it is also production
1242+
If a branch is specified and doesn't match the main branch, it is a branch deploy
12401243
required: false
12411244
in: query
12421245
type: string

0 commit comments

Comments
 (0)