chore(api-spec): update session endpoint specs #110
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the OpenAPI specification for the session endpoints to align the response definitions to the API changes made in teamhanko/hanko#2003 .
Changes Made
Endpoint Response Updates:
500
responses (InternalServerError
) to theGET /sessions/validate
andPOST /sessions/validate
endpoints for better documentation of potential server errors.400
responses (BadRequest
) for these endpoints.Schema Enhancements:
JWTClaims
, to describe the claims extracted from JWTs.subject
,issued_at
,expiration
,audience
,issuer
,email
, andsession_id
.ValidateSessionResponse
schema:expires_at
user_id
Notes
JWTClaims
schema as the deprecated fields will be removed in a future release.