Browse Source

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
pull/6825/head
Chris Piraino 5 years ago committed by Chris Piraino
parent
commit
cf69630620
  1. 7
      website/source/api/session.html.md

7
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: "<agent>")` - Specifies the name of the node. This must refer
to a node that is already registered.

Loading…
Cancel
Save