nuts-foundation / nuts-foundation/nuts-node

OpenAPI: /request-credential description mentions session_id but schema doesn't return it

Open Beginner friendly
#4,230 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
28
Forks
23
Avg merge
1d 10h
Merged PRs (30d)
76

Description

Problem

The POST /internal/auth/v2/{subjectID}/request-credential endpoint in docs/_static/auth/v2.yaml has a misleading response description.

The description on the 200 response says:

Successful request. Responds with a redirect_uri for the user and a session_id for correlation.

However, the schema referenced by that response is RedirectResponse, which only contains redirect_uri — no session_id. The session_id field belongs to RedirectResponseWithID, used by other endpoints (e.g. request-user-access-token).

See:

  • Description: docs/_static/auth/v2.yaml around line 188-189
  • RedirectResponse schema: docs/_static/auth/v2.yaml:552
  • RedirectResponseWithID schema: docs/_static/auth/v2.yaml:562

Fix options

Either:

  1. Update the description to drop the session_id mention (if no correlation ID is actually needed for this flow), or
  2. Change the response schema to RedirectResponseWithID and have the implementation return a session_id (if correlation is intended).

Option 1 matches current behavior; option 2 would be a behavioral change.

Assisted by AI

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open docs/_static/auth/v2.yaml around lines 188-189, then compare the request-credential response with the RedirectResponse and RedirectResponseWithID schemas around lines 552 and 562. Confirm the documented response matches current behavior and ensure the completed description no longer claims a session_id when the referenced schema does not return one.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.