Update /v1/job API docs with namespace parameter

This commit is contained in:
Daniel Santos
2021-03-24 07:31:39 -06:00
committed by GitHub
parent 4484d361ee
commit 26ba3fa9d3

View File

@@ -290,6 +290,8 @@ 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.
- `namespace` `(string: "default")` - Specifies the namespace of the job. If not specified,
defaults to "default". This is specified as a URL query parameter.
### Sample Request
@@ -298,11 +300,17 @@ $ curl \
https://localhost:4646/v1/job/my-job
```
```shell-session
$ curl \
https://localhost:4646/v1/job/my-job?namespace=apps
```
### Sample Response
```json
{
"Region": "global",
"Namespace": "apps",
"ID": "example",
"ParentID": "",
"Name": "example",