From e515c9d44950b459ef156463c7c084ed2b1a8ab2 Mon Sep 17 00:00:00 2001
From: Blake Covarrubias <blake@covarrubi.as>
Date: Mon, 19 Jul 2021 23:52:21 -0700
Subject: [PATCH] docs: Update responses for /v1/session/ endpoints post 1.7

Update output for /v1/session/ endpoints to match output post Consul
1.7.0.

Documents new `NodeChecks` and `ServiceChecks` parameters which were
added in that release.

Resolves #7341, resolves #10095
---
 website/content/api-docs/session.mdx | 46 ++++++++++++++++++++--------
 1 file changed, 34 insertions(+), 12 deletions(-)

diff --git a/website/content/api-docs/session.mdx b/website/content/api-docs/session.mdx
index 8334e5951d..c49dba57c5 100644
--- a/website/content/api-docs/session.mdx
+++ b/website/content/api-docs/session.mdx
@@ -46,9 +46,19 @@ The table below shows this endpoint's support for
 
 - `Name` `(string: "")` - Specifies a human-readable name for the session.
 
-- `Checks` `(array<string>: nil)` - specifies a list of associated health
+- `Checks` `(array<string>: nil)` - Specifies a list of node health
   check IDs (commonly `CheckID` in API responses). It is highly recommended that,
   if you override this list, you include the default `serfHealth`.
+  Deprecated in Consul 1.7.0 and replaced by `NodeChecks`. This field will be
+  omitted from the API response in Consul 1.7+ if `serfHealth` is the only defined check.
+
+- `NodeChecks` `(array<string>: nil)` - Specifies a list of node health
+  check IDs (commonly `CheckID` in API responses). It is highly recommended that,
+  if you override this list, you include the default `serfHealth`. Added in
+  Consul 1.7.0.
+
+- `ServiceChecks` `(array<string>: nil)` - Specifies a list of service health
+  check IDs (commonly `CheckID` in API responses). Added in Consul 1.7.0.
 
 - `Behavior` `(string: "release")` - Controls the behavior to take when a
   session is invalidated. Valid values are:
@@ -88,7 +98,7 @@ $ curl \
 
 ### Sample Response
 
-```javascript
+```json
 {
   "ID": "adf4238a-882b-9ddc-4a9d-5b6758e4159e"
 }
@@ -195,10 +205,13 @@ $ curl \
     "ID": "adf4238a-882b-9ddc-4a9d-5b6758e4159e",
     "Name": "test-session",
     "Node": "raja-laptop-02",
-    "Checks": ["serfHealth"],
-    "LockDelay": 1.5e10,
+    "LockDelay": 15000000000,
     "Behavior": "release",
     "TTL": "30s",
+    "NodeChecks": [
+      "serfHealth"
+    ],
+    "ServiceChecks": null,
     "CreateIndex": 1086449,
     "ModifyIndex": 1086449
   }
@@ -255,11 +268,14 @@ $ curl \
   {
     "ID": "adf4238a-882b-9ddc-4a9d-5b6758e4159e",
     "Name": "test-session",
-    "Node": "raja-laptop-02",
-    "Checks": ["serfHealth"],
-    "LockDelay": 1.5e10,
+    "Node": "node-abcd1234",
+    "LockDelay": 15000000000,
     "Behavior": "release",
     "TTL": "30s",
+    "NodeChecks": [
+      "serfHealth"
+    ],
+    "ServiceChecks": null,
     "CreateIndex": 1086449,
     "ModifyIndex": 1086449
   }
@@ -311,10 +327,13 @@ $ curl \
     "ID": "adf4238a-882b-9ddc-4a9d-5b6758e4159e",
     "Name": "test-session",
     "Node": "raja-laptop-02",
-    "Checks": ["serfHealth"],
-    "LockDelay": 1.5e10,
+    "LockDelay": 15000000000,
     "Behavior": "release",
     "TTL": "30s",
+    "NodeChecks": [
+      "serfHealth"
+    ],
+    "ServiceChecks": null,
     "CreateIndex": 1086449,
     "ModifyIndex": 1086449
   }
@@ -370,10 +389,13 @@ $ curl \
     "ID": "adf4238a-882b-9ddc-4a9d-5b6758e4159e",
     "Name": "test-session",
     "Node": "raja-laptop-02",
-    "Checks": ["serfHealth"],
-    "LockDelay": 1.5e10,
+    "LockDelay": 15000000000,
     "Behavior": "release",
-    "TTL": "15s",
+    "TTL": "30s",
+    "NodeChecks": [
+      "serfHealth"
+    ],
+    "ServiceChecks": null,
     "CreateIndex": 1086449,
     "ModifyIndex": 1086449
   }