Skip to content

docs: fix JWT auth example hierarchy in router authentication guide #8901

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mabuyo merged 5 commits into from
Feb 26, 2026
Merged

docs: fix JWT auth example hierarchy in router authentication guide #8901

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
70ce819
docs: fix JWT auth example hierarchy in router authentication guide
the-gigi Feb 19, 2026
a9e3144
docs: add changeset for JWT auth example fix
the-gigi Feb 19, 2026
dfcf3c7
docs: set PR link in JWT example changeset
the-gigi Feb 19, 2026
211331d
docs: quote JWT on_error value in auth example
the-gigi Feb 19, 2026
5476f46
Merge branch 'dev' into gigi/dxm-515-fix-jwt-authentication-router-ex…
mabuyo Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changesets/docs_fix_jwt_router_auth_example_hierarchy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
### Fix JWT authentication example hierarchy in the router authentication guide

Updated the GraphOS Router authentication guide to use the correct JWT configuration path in the YAML example. The example now shows `authentication.router.jwt.jwks` and `authentication.router.jwt.on_error`, matching the actual router configuration hierarchy.

By [@the-gigi-apollo](https://github.com/the-gigi-apollo) in https://github.com/apollographql/router/pull/8901
9 changes: 5 additions & 4 deletions docs/source/routing/security/router-authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,10 +120,11 @@

```yaml
authentication:
jwt:
jwks:
- url: https://dev-zzp5enui.us.auth0.com/.well-known/jwks.json
on_error: Error
router:
jwt:
jwks:
- url: https://dev-zzp5enui.us.auth0.com/.well-known/jwks.json

Check warning on line 126 in docs/source/routing/security/router-authentication.mdx

View check run for this annotation

Apollo Librarian / AI Style Review

docs/source/routing/security/router-authentication.mdx#L126 

**Structural Elements**: YAML indentation should use exactly 2 spaces per level. This list item should be indented 2 spaces relative to its parent.

```suggestion
          - url: https://dev-zzp5enui.us.auth0.com/.well-known/jwks.json
```
on_error: "Error"
```

Pros:
Expand Down