From 6e208a2120cce0d2cd680753bef6261665383bd9 Mon Sep 17 00:00:00 2001 From: Dexter Lowe Date: Thu, 18 Jun 2020 18:53:43 +0100 Subject: [PATCH] #8059 Improve Clarity on TTL docs (#8141) --- website/pages/api-docs/session.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/pages/api-docs/session.mdx b/website/pages/api-docs/session.mdx index 98a28c8895..14efc1d7d6 100644 --- a/website/pages/api-docs/session.mdx +++ b/website/pages/api-docs/session.mdx @@ -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