docs: improve JWT configuration page #873
Conversation
|
@hgiasac Thanks for your PR! I've assigned @seanparkross to review it. |
DX: Assertion Testing✅ DiffThe changes in the PR provide a more structured and modern configuration format for JWT by replacing JSON with YAML and making certain fields clearer. This will likely improve the usability for users who prefer YAML syntax and those who find declarative configurations more intuitive. You have effectively split individual concerns into their specific configuration areas, such as 'claimsConfig' for claim-related settings and 'tokenLocation' for specifying the JWT location in the request. The replacement of the 'type' and 'key' minimum presence check with 'claimsConfig', 'tokenLocation', and 'key' is another positive change as it makes the minimum requirement more explicit. ✅ IntegratedThe PR successfully integrates the piecewise updates into the overarching configuration documentation. The transition to the new format occurs across all relevant sections, maintaining overall consistency and coherence. The provided examples are in sync with the updated schema and should greatly help users to correctly configure JWT authentication. Furthermore, the PR maintains continuity with existing JWT claims and fields, only changing the way they are represented rather than the underlying functionality, which should ensure backward compatibility and ease of adoption for existing users. |
| "allowed_skew": "optional-number-of-seconds-in-integer", | ||
| "header": "optional-key-to-indicate-cookie-or-authorization-header" | ||
| } | ||
| ```yaml title="globals/metadata/auth-config.hml" |
There was a problem hiding this comment.
@hgiasac So this section has changed to be about the AuthConfig definition rather than the JWT token definition. Do we not need a JWT payload definition also?
There was a problem hiding this comment.
No. That JWT definition is a JSON string in v2 when configuring the HASURA_GRAPHQL_JWT_SECRET env variable. In Hasura DDN, JWT is just an auth mode of AuthConfig and the syntax is different from v2.
We can link the definition to the JWT section in AuthConfig reference instead.
Description 📝
Many JWT configurations in Hasura v2 are no longer valid in Hasura DDN. This PR rewrites the JWT configuration page to improve the correctness.
Quick Links 🚀
https://fix-jwt-auth-configuration.v3-docs-eny.pages.dev/auth/jwt/jwt-configuration/
Assertion Tests 🤖