luxolus
/
open-nomad
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

docs: add global query param to API job deregister endpoint.

This commit is contained in:
James Rasell 2021-11-19 13:45:24 +01:00
parent 83b654b866
commit 88cc158ae1
No known key found for this signature in database
GPG Key ID: AA7D460F5C8377AA
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
website/content/api-docs/jobs.mdx
View File

@ -2099,7 +2099,10 @@ The table below shows this endpoint's support for
- `:job_id` `(string: <required>)` - Specifies the ID of the job (as specified in
the job file during submission). This is specified as part of the path.
- `purge` `(bool: false)` - Specifies that the job should stopped and purged
- `global` `(bool: false)` - Stop a multi-region job in all its regions. By default,
job stop will stop only a single region at a time. Ignored for single-region jobs.
- `purge` `(bool: false)` - Specifies that the job should be stopped and purged
immediately. This means the job will not be queryable after being stopped. If
not set, the job will be purged by the garbage collector.