Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Quick Start: verifier steps name response IDs absent from Agent 2.0.0

Open Beginner friendly
#294 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
83/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
documentation

Research direction

Edit documentation/develop/quick-start.md at the connected response, connectionless response, and polling command sections. Compare their field names with the pinned Agent 2.0.0 PresentationStatus and OOBPresentationInvitation schemas linked in the issue, then update both branches and polling instructions to match. Done when each branch names fields present in its response and polling uses the presentation record ID, with the invitation ID and URL identified separately.

Written by the indexing model from the issue text.

Description

documentation

User impact

Verifier developers are told to extract nonexistent fields, then use one to poll a presentation record; the connectionless branch also leaves the actual invitation URL field unclear.

Affected documentation and ownership

  • Page: Quick Start Guide, GET 200 at 2026-10-28 20:48:50 UTC; affected source text is also deployed.
  • Editable owner: hyperledger-identus/docs, local hand-authored documentation/develop/quick-start.md at fa985dfa33caefa45bf1e9009e1f6f5a445344fb; not imported SDK content or generated API output.
  • Intended versions: page environment pins select Agent 2.0.0 (5865d9470dc5ce6631aec780e7cf63d4f454555a); SDK checkout selects v6.6.0 (1a9da8135ec5745bca182904f0a1703d7be6d1a2). Matching pins, not latest releases, govern this comparison.
  • Affected text: Connected response, connectionless response, and polling command.

Observed versus expected

The guide says POST /present-proof/presentations returns presentationRequestId, then uses that name for polling. It says POST /presentations/invitation returns invitationId. Both pinned endpoints actually return PresentationStatus, with presentationId; the OOB invitation is nested as invitation.id / invitation.invitationUrl. Expected: identify the actual response fields and carry the presentation record ID into polling separately from the invitation ID/URL.

Evidence and reproduction

Statically compare:

No live Agent response was obtained; names follow pinned case classes/derived JSON encoders and API schema.

Verification used Python 3.13.15 text/HTML inspection of immutable public sources and deployed text. No repository code, compiler/build, service request or browser test was run; deployment commit identity is not exposed.

Existing work checked

Fully paginated open/closed issue-and-PR inventories in docs, cloud-agent and sdk-ts, plus title/body/comment searches by page/component/root cause and relevant discussion/patch reads. Searched Quick Start/path, presentationRequestId, invitationId, schemaId and presentation root causes. docs PR #54, #159, and later Quick Start patches introduce/retain these names rather than repair them. cloud-agent #1485 is a closed unreproduced HTTP 500 report; its discussion shows presentationId but does not own this portal-text correction. This is not a recurrence of that server error. No matching open repair was found.

Acceptance criteria

  • Both verifier branches identify output fields present in Agent 2.0.0 responses.
  • The polling command uses the returned presentation-record ID, while OOB instructions identify the separate nested invitation URL/ID.
  • Check revised text against matching response schemas and safe local response fixtures or the pinned Agent.
Dominant language
TypeScript
Stars
15
Forks
8
Avg merge
3d 14h
Merged PRs (30d)
2

Getting set up

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.

More from hyperledger-identus/docs

All issues in hyperledger-identus/docs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.