Skip to content

Commit

Permalink
docs: upgrade guide to v4
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonraimondi committed Aug 12, 2024
1 parent cfe994b commit 3c195ae
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion docs/docs/upgrade_guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,34 @@
# Upgrade Guide

## From v2 to v3
## To v4

### Breaking Change

Only affects users implementing the `/revoke` and `/introspect` endpoints

- [`/introspect`](https://tsoauth2server.com/docs/endpoints/introspect) will now authenticate via client_credentials by default
- [`/revoke`](https://tsoauth2server.com/docs/endpoints/revoke) will now authenticate via client_credentials by default

Before (v3.x):

```ts
new AuthorizationServer(..., {
authenticateIntrospect: false,
authenticateRevoke: false,
})
```

Before (v4.x):


```ts
new AuthorizationServer(..., {
authenticateIntrospect: true, // set to false to match 3.x
authenticateRevoke: true, // set to false to match 3.x
})
```

## To v3

### This package is now pure ESM

Expand Down

0 comments on commit 3c195ae

Please sign in to comment.