Skip to content
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.

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

chore(api-spec): update session endpoint specs #110

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bjoern-m
Copy link
Contributor

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

  1. Endpoint Response Updates:

    • Added 500 responses (InternalServerError) to the GET /sessions/validate and POST /sessions/validate endpoints for better documentation of potential server errors.
    • Enhanced the 400 responses (BadRequest) for these endpoints.
  2. Schema Enhancements:

    • Introduced a new schema, JWTClaims, to describe the claims extracted from JWTs.
    • Includes fields are: subject, issued_at, expiration, audience, issuer, email, and session_id.
    • Deprecated the following fields in the ValidateSessionResponse schema:
      • expires_at
      • user_id

Notes

  • Consumers of the API are encouraged to transition to the new JWTClaims schema as the deprecated fields will be removed in a future release.

@bjoern-m bjoern-m marked this pull request as ready for review December 30, 2024 11:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant