From 5cae8f1d8415d0a771ffde2301456fe0e417da0f Mon Sep 17 00:00:00 2001 From: Nick Spain Date: Thu, 18 Mar 2021 22:27:48 +1100 Subject: [PATCH] Document usage of 'body' field --- website/content/api-docs/json-jobs.mdx | 2 ++ website/content/docs/job-specification/service.mdx | 2 ++ 2 files changed, 4 insertions(+) diff --git a/website/content/api-docs/json-jobs.mdx b/website/content/api-docs/json-jobs.mdx index 960e85598..8021756c8 100644 --- a/website/content/api-docs/json-jobs.mdx +++ b/website/content/api-docs/json-jobs.mdx @@ -496,6 +496,8 @@ The `Task` object supports the following keys: - `Method`: The HTTP method to use for HTTP checks. Defaults to GET. + - `Body`: The HTTP body to use for HTTP checks. Defaults to an empty string. + - `Path`: The path of the HTTP endpoint which Consul will query to query the health of a service if the type of the check is `http`. Nomad will add the IP of the service and the port, users are only required diff --git a/website/content/docs/job-specification/service.mdx b/website/content/docs/job-specification/service.mdx index 1a08cc00c..464d4d565 100644 --- a/website/content/docs/job-specification/service.mdx +++ b/website/content/docs/job-specification/service.mdx @@ -246,6 +246,8 @@ scripts. - `method` `(string: "GET")` - Specifies the HTTP method to use for HTTP checks. +- `body` `(string: "")` - Specifies the HTTP body to use for HTTP checks. + - `name` `(string: "service: check")` - Specifies the name of the health check. If the name is not specified Nomad generates one based on the service name. If you have more than one check you must specify the name.