Skip to content

Commit 51a02c6

Browse files
committed
docs: Add breaking change to 3.0 migration guide.
The changed behavior of accessTokenLifetime is a undocumented breaking change in 3.0. The old behavior was spec-compliant and explicitly documented as an advertised fature in the CHANGELOG entry for 1.5.0, so a "Breaking Change" notice is warranted. The spec is clear that the expiration date is *recommended*, not required. Ref: https://tools.ietf.org/html/rfc6749#section-5.1
1 parent e1f741f commit 51a02c6

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/misc/migrating-v2-to-v3.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,11 @@ The following server options can be set when instantiating the OAuth service:
4040
* `allowExtendedTokenAttributes`: **default false** Allows additional attributes (such as `id_token`) to be included in token responses.
4141
* `requireClientAuthentication`: **default true for all grant types** Allow ability to set client/secret authentication to `false` for a specific grant type.
4242

43-
The following server options have been removed in v3.0.0
43+
The following server options have changed behavior in v3.0.0:
44+
45+
* `accessTokenLifetime` can no longer be set to `null` to indicate a non-expiring token. The recommend alternative is to set accessTokenLifetime to a high value.
46+
47+
The following server options have been removed in v3.0.0:
4448

4549
* `grants`: **removed** (now returned by the `getClient` method).
4650
* `debug`: **removed** (not the responsibility of this module).

0 commit comments

Comments
 (0)