Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport of docs: add namespace param to job parse API into stable-website #12259

Merged
merged 1 commit into from
Mar 10, 2022
Merged

Backport of docs: add namespace param to job parse API into stable-website #12259

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions website/content/api-docs/jobs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,8 +209,13 @@ The table below shows this endpoint's support for

### Parameters

- `namespace` `(string: "default")` - Specifies the target namespace. If ACL is
enabled, this value must match a namespace that the token is allowed to
access. This is specified as a query string parameter.

- `JobHCL` `(string: <required>)` - Specifies the HCL definition of the job
encoded in a JSON string.

- `Canonicalize` `(bool: false)` - Flag to enable setting any unset fields to
their default values.

Expand Down