status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

#8059 Improve Clarity on TTL docs (#8141)

This commit is contained in:
Dexter Lowe 2020-06-18 18:53:43 +01:00 committed by GitHub
parent af11169c26
commit 6e208a2120
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
website/pages/api-docs/session.mdx
View File

@ -57,13 +57,13 @@ The table below shows this endpoint's support for
- `release` - causes any locks that are held to be released
- `delete` - causes any locks that are held to be deleted
- `TTL` `(string: "")` - Specifies the number of seconds (between 10s and
- `TTL` `(string: "")` - Specifies the duration of a session (between 10s and
86400s). If provided, the session is invalidated if it is not renewed before
the TTL expires. The lowest practical TTL should be used to keep the number of
managed sessions low. When locks are forcibly expired, such as when following
the [leader election pattern](https://learn.hashicorp.com/consul/developer-configuration/elections) in an application,
sessions may not be reaped for up to double this TTL, so long TTL
values (> 1 hour) should be avoided.
values (> 1 hour) should be avoided. Valid time units include "s", "m" and "h".
### Sample Payload