Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#294 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
83/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Lĩnh vực
documentation

Hướng nghiên cứu

Chỉnh sửa documentation/develop/quick-start.md tại các phần về phản hồi có kết nối, phản hồi không kết nối và lệnh polling. Đối chiếu tên trường với các schema được cố định PresentationStatus và OOBPresentationInvitation của Agent 2.0.0 được liên kết trong issue, sau đó cập nhật cả hai nhánh và hướng dẫn polling cho khớp. Hoàn tất khi mỗi nhánh nêu các trường có trong phản hồi của nó và polling sử dụng ID của bản ghi presentation, còn ID invitation và URL được xác định riêng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

bug documentation ready-for-agent

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.
Ngôn ngữ chính
TypeScript
Star
15
Fork
8
Merge trung bình
3 ngày 14 giờ
Pull request đã merge (30 ngày)
2

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của hyperledger-identus/docs

Tất cả issue của hyperledger-identus/docs

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.