docs: add dcql-support doc and improve ovp support as per latest impl #2510
docs: add dcql-support doc and improve ovp support as per latest impl #2510KiruthikaJeyashankar wants to merge 4 commits into
Conversation
Signed-off-by: KiruthikaJeyashankar <kiruthikavjshankar@gmail.com>
Signed-off-by: KiruthikaJeyashankar <kiruthikavjshankar@gmail.com>
|
Warning Review limit reached
Next review available in: 36 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
WalkthroughThe PR removes the top-level OpenID4VP support doc, adds a reorganized OpenID4VP support page under ChangesOpenID4VP documentation updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (5)
docs/openid4vp/dcql-query-support.md (3)
291-291: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winFix grammar in DCQL SD-JWT description.
"due to DCQL having different in claim path matching" is grammatically incorrect. Should be "due to differences in claim path matching" or "due to DCQL's different claim path matching".
- - **DCQL:** Uses `getDisclosuresForPath()` for comprehensive disclosure handling due to DCQL having different in claim path matching + - **DCQL:** Uses `getDisclosuresForPath()` for comprehensive disclosure handling due to differences in claim path matching🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/openid4vp/dcql-query-support.md` at line 291, The DCQL SD-JWT description has a grammar issue in the phrase used alongside getDisclosuresForPath(); update the wording to use a correct form such as “due to differences in claim path matching” or “due to DCQL’s different claim path matching” while keeping the rest of the documentation unchanged.
145-145: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueRemove redundant separator.
The extra
---at line 145 creates an unnecessary visual break immediately following the previous section separator. This disrupts document flow.- --- - -🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/openid4vp/dcql-query-support.md` at line 145, The document has a redundant horizontal separator immediately after the previous section break in the OpenID4VP DCQL query support doc. Remove the extra separator in this section so the flow stays continuous, and verify the nearby section boundary markup remains correct around the affected markdown block.
286-286: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winFix heading level for format subsection.
The
#### ldp_vc (Linked Data Proof)heading at line 286 follows## Format-Specific Processing in DCQL(h2). Per markdownlint MD001, this should be###(h3) to maintain proper heading hierarchy without skipping levels.- #### ldp_vc (Linked Data Proof) + ### ldp_vc (Linked Data Proof)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/openid4vp/dcql-query-support.md` at line 286, The heading for the linked data proof format subsection is at the wrong hierarchy level, skipping from the enclosing Format-Specific Processing in DCQL section; update the ldp_vc heading to match a third-level subsection so it follows the existing section structure correctly. Use the markdown heading for ldp_vc as the anchor and keep the surrounding format subsections consistent with the same level.docs/openid4vp/openid4vp-support.md (2)
31-31: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winUse uppercase
GETfor HTTP method consistency.Line 31 uses lowercase "get" as the default value for
request_uri_method, but line 25 correctly uses uppercase "POST". HTTP methods should be consistently uppercase per RFC 9110.- - request_uri_method (Optional | Default value : get) + - request_uri_method (Optional | Default value : GET)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/openid4vp/openid4vp-support.md` at line 31, The default value for request_uri_method is inconsistent with HTTP method naming elsewhere in openid4vp-support.md; update the documented default from lowercase get to uppercase GET to match the existing POST usage and keep method names consistent. Locate the request_uri_method entry in the OpenID4VP support documentation and change only the default value text.
93-93: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winFix heading level to comply with markdown structure.
The
##### Authorization Request Handling:heading jumps from h2 (## Implementationat line 79) to h5. Per markdownlint MD001, heading levels should only increment by one level at a time. This should be###(h3) to maintain proper document outline structure.- ##### Authorization Request Handling: + ### Authorization Request Handling🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/openid4vp/openid4vp-support.md` at line 93, The markdown heading for Authorization Request Handling uses a level that skips the document outline from the surrounding Implementation section. Update the heading in the openid4vp-support document to use the next sequential level from the existing h2 “Implementation” heading, and keep the section title text unchanged so the outline remains consistent and markdownlint MD001 is satisfied.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/openid4vp/openid4vp-support.md`:
- Line 176: The SD-JWT VC documentation link in the OpenID4VP support doc uses
the wrong HTML anchor fragment, so update the existing reference to
draft-ietf-oauth-sd-jwt-vc-10 by replacing the invalid section-based fragment
with the standard Section 3.2.2.2 anchor used in IETF HTML docs. Keep the
surrounding text unchanged and fix the markdown link so it points to the correct
registered JWT claims section.
---
Nitpick comments:
In `@docs/openid4vp/dcql-query-support.md`:
- Line 291: The DCQL SD-JWT description has a grammar issue in the phrase used
alongside getDisclosuresForPath(); update the wording to use a correct form such
as “due to differences in claim path matching” or “due to DCQL’s different claim
path matching” while keeping the rest of the documentation unchanged.
- Line 145: The document has a redundant horizontal separator immediately after
the previous section break in the OpenID4VP DCQL query support doc. Remove the
extra separator in this section so the flow stays continuous, and verify the
nearby section boundary markup remains correct around the affected markdown
block.
- Line 286: The heading for the linked data proof format subsection is at the
wrong hierarchy level, skipping from the enclosing Format-Specific Processing in
DCQL section; update the ldp_vc heading to match a third-level subsection so it
follows the existing section structure correctly. Use the markdown heading for
ldp_vc as the anchor and keep the surrounding format subsections consistent with
the same level.
In `@docs/openid4vp/openid4vp-support.md`:
- Line 31: The default value for request_uri_method is inconsistent with HTTP
method naming elsewhere in openid4vp-support.md; update the documented default
from lowercase get to uppercase GET to match the existing POST usage and keep
method names consistent. Locate the request_uri_method entry in the OpenID4VP
support documentation and change only the default value text.
- Line 93: The markdown heading for Authorization Request Handling uses a level
that skips the document outline from the surrounding Implementation section.
Update the heading in the openid4vp-support document to use the next sequential
level from the existing h2 “Implementation” heading, and keep the section title
text unchanged so the outline remains consistent and markdownlint MD001 is
satisfied.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 96ba0e01-164b-4b93-9953-ba795f4f7c40
📒 Files selected for processing (3)
docs/openid4vp-support.mddocs/openid4vp/dcql-query-support.mddocs/openid4vp/openid4vp-support.md
💤 Files with no reviewable changes (1)
- docs/openid4vp-support.md
Signed-off-by: KiruthikaJeyashankar <kiruthikavjshankar@gmail.com>
Signed-off-by: KiruthikaJeyashankar <kiruthikavjshankar@gmail.com>
KiruthikaJeyashankar
force-pushed
the
udpate-ovp-docs
branch
from
55732d6 to
63f10a1
Compare
1 participant
Summary by CodeRabbit