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

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
This commit is contained in:
Blake Covarrubias 2021-08-03 09:57:31 -07:00 committed by GitHub
parent d1ce78db38
commit 0a95b668d4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
website/content/api-docs/session.mdx
View File

@ -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 if you override this list, you include the default `serfHealth`. Added in
Consul 1.7.0. Consul 1.7.0.
- `ServiceChecks` `(array<string>: nil)` - Specifies a list of service health - `ServiceChecks` `(array<ServiceCheck>: nil)` - Specifies a list of service
check IDs (commonly `CheckID` in API responses). Added in Consul 1.7.0. checks. Added in Consul 1.7.0. A service check has the following fields:
- `ID` `(string: <required>)` - The ID of the service check to monitor
(commonly `CheckID` in API responses).
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the
namespace in which to resolve the service check ID.
- `Behavior` `(string: "release")` - Controls the behavior to take when a - `Behavior` `(string: "release")` - Controls the behavior to take when a
session is invalidated. Valid values are: session is invalidated. Valid values are: