From 370a76ff3ed1dce10234e7d68cc6a3fbc08ecb30 Mon Sep 17 00:00:00 2001 From: Blake Covarrubias Date: Tue, 3 Aug 2021 09:57:31 -0700 Subject: [PATCH] docs: Fix service checks docs on session endpoint (#10759) The ServiceChecks parameter was incorrectly documented in e515c9d44 to state that it accepted a list of string values, when actually the API requires an array of ServiceCheck objects. This commit updates the docs for the parameter to correctly reflect the fields required by the API. Resolves #10752 --- website/content/api-docs/session.mdx | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/website/content/api-docs/session.mdx b/website/content/api-docs/session.mdx index c49dba57c5..63766f32b5 100644 --- a/website/content/api-docs/session.mdx +++ b/website/content/api-docs/session.mdx @@ -57,8 +57,14 @@ The table below shows this endpoint's support for if you override this list, you include the default `serfHealth`. Added in Consul 1.7.0. -- `ServiceChecks` `(array: nil)` - Specifies a list of service health - check IDs (commonly `CheckID` in API responses). Added in Consul 1.7.0. +- `ServiceChecks` `(array: nil)` - Specifies a list of service + checks. Added in Consul 1.7.0. A service check has the following fields: + + - `ID` `(string: )` - The ID of the service check to monitor + (commonly `CheckID` in API responses). + + - `Namespace` `(string: "")` - Specifies the + namespace in which to resolve the service check ID. - `Behavior` `(string: "release")` - Controls the behavior to take when a session is invalidated. Valid values are: