From cf69630620d3ce0c7a466bf2bd4d73037e95893d Mon Sep 17 00:00:00 2001 From: Chris Piraino Date: Tue, 12 Nov 2019 11:12:36 -0600 Subject: [PATCH] Improve session API documentation - Remove incorrect statement that `LockDelay` must be greater than 0 - Add sentence to the top of the page pointing to the internal document describing the sessions mechanism for more context --- website/source/api/session.html.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/website/source/api/session.html.md b/website/source/api/session.html.md index 52dd038c37..8c00636569 100644 --- a/website/source/api/session.html.md +++ b/website/source/api/session.html.md @@ -8,7 +8,9 @@ description: |- # Session HTTP Endpoint -The `/session` endpoints create, destroy, and query sessions in Consul. +The `/session` endpoints create, destroy, and query sessions in Consul. A +conceptual overview of sessions is found at the +[Session Internals](/docs/internals/sessions.html) page. ## Create Session @@ -35,8 +37,7 @@ The table below shows this endpoint's support for the datacenter of the agent being queried. This is specified as part of the URL as a query parameter. Using this across datacenters is not recommended. -- `LockDelay` `(string: "15s")` - Specifies the duration for the lock delay. This - must be greater than `0`. +- `LockDelay` `(string: "15s")` - Specifies the duration for the lock delay. - `Node` `(string: "")` - Specifies the name of the node. This must refer to a node that is already registered.