github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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 2019-11-12 11:12:36 -06:00 committed by Chris Piraino
parent 9c0e1a5b08
commit cf69630620
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
website/source/api/session.html.md
View File

@ -8,7 +8,9 @@ description: |-
# Session HTTP Endpoint # 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 ## 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 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. URL as a query parameter. Using this across datacenters is not recommended.
- `LockDelay` `(string: "15s")` - Specifies the duration for the lock delay. This - `LockDelay` `(string: "15s")` - Specifies the duration for the lock delay.
must be greater than `0`.
- `Node` `(string: "<agent>")` - Specifies the name of the node. This must refer - `Node` `(string: "<agent>")` - Specifies the name of the node. This must refer
to a node that is already registered. to a node that is already registered.