From 26ba3fa9d35956136de22e223241b24dbd90c406 Mon Sep 17 00:00:00 2001 From: Daniel Santos Date: Wed, 24 Mar 2021 07:31:39 -0600 Subject: [PATCH] Update /v1/job API docs with namespace parameter --- website/content/api-docs/jobs.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/website/content/api-docs/jobs.mdx b/website/content/api-docs/jobs.mdx index 94310569b..d9f65e8ec 100644 --- a/website/content/api-docs/jobs.mdx +++ b/website/content/api-docs/jobs.mdx @@ -290,6 +290,8 @@ The table below shows this endpoint's support for - `:job_id` `(string: )` - 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",