[INJIVER-1369] Document CWT VC support and limitations#222
[INJIVER-1369] Document CWT VC support and limitations#222mayuradesh merged 6 commits intoinji:developfrom
Conversation
Signed-off-by: jaswanthkumarpolisetty <jaswanthkumar.p@thoughtworks.com>
…jiver-1369-readme
Signed-off-by: jaswanthkumarpolisetty <jaswanthkumar.p@thoughtworks.com>
WalkthroughAdds CWT (CBOR Web Token) Verifiable Credential validation docs and support: introduces public Changes
Sequence Diagram(s)(omitted) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@vc-verifier/kotlin/README.md`:
- Around line 58-60: Remove the stray closing bold marker by deleting the
trailing "**" after "PS256" in the sentence "RSA-based algorithms (e.g., RS256 /
PS256)** are not supported for CWT verification"; update the text so it reads
normally (e.g., "RSA-based algorithms (e.g., RS256 / PS256) are not supported
for CWT verification") to eliminate the malformed Markdown bolding.
- Line 13: Update the broken TOC link in README.md by replacing the incorrect
anchor in the TOC entry "3.4 [CWT VC Validation](`#34-sd-jwt-vc-validation`)" with
the correct anchor that matches the heading "CWT VC Validation" (use
"#cwt-vc-validation" or "#34-cwt-vc-validation" depending on your TOC/anchor
generation policy) so the link targets the "CWT VC Validation" section
correctly.
🧹 Nitpick comments (1)
vc-verifier/kotlin/README.md (1)
128-188: Comprehensive CWT VC validation documentation.The validation flow is well-documented, covering COSE_Sign1 structure, protected header validation, CWT claims, and temporal checks.
One optional consideration: the nested list indentation uses 4 spaces where the linter (markdownlint) expects 2 spaces. If you want linter compliance, reduce indentation from 4 to 2 spaces for nested items. However, this is a style preference and doesn't affect readability.
…jiver-1369-readme
Signed-off-by: jaswanthkumarpolisetty <jaswanthkumar.p@thoughtworks.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@vc-verifier/kotlin/README.md`:
- Around line 55-56: Update the inconsistent format name from "vc-cwt" to
"cwt_vc" in the sentence that mentions planned support for other VC formats so
it matches the supported formats table and other occurrences; locate the string
"vc-cwt" in the README.md (the sentence that lists `vc+sd-jwt`,`vc-cwt`) and
replace it with `cwt_vc`.
Signed-off-by: jaswanthkumarpolisetty <jaswanthkumar.p@thoughtworks.com>
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
vc-verifier/kotlin/README.md (1)
388-396: Align API examples and feature matrix documentation for CWT_VC status check support.The API documentation lists
CWT_VCas a validcredentialFormatparameter forgetCredentialStatus(lines 388-396), but the feature matrix marks status check as ❌ forcwt_vc(lines 771-776). The implementation acceptsCWT_VCand returns an empty status map rather than throwing an unsupported error. Clarify whether this format should list ✔️ with a note like "returns empty status" or be removed from the API examples if intentionally unsupported.
🤖 Fix all issues with AI agents
In `@vc-verifier/kotlin/README.md`:
- Around line 908-909: Replace the bold Markdown line "**cwt_vc Format VC Error
Codes**" with a proper heading to satisfy markdownlint MD036; for example change
it to "#### cwt_vc Format VC Error Codes" so the section uses a heading level
instead of bold text (locate the exact bold text string in the README.md and
update it accordingly).
- Around line 133-186: The markdown bullets under "CWT payload validation" and
the nested "Numeric date validation (RFC 8392)" block are mis-indented causing
MD007; fix by normalizing indentation so top-level bullets use no extra leading
spaces, nested bullets (e.g., the items under "Numeric date validation" and the
three temporal claims `exp`, `nbf`, `iat`) are indented by 2 spaces, and any
sub-nested bullets (like the conditions under each temporal claim) are indented
by 4 spaces; apply this consistently for the sections referencing "CWT payload
validation", "Numeric date validation (RFC 8392)", and the list of temporal
checks so markdownlint no longer flags MD007.
Summary by CodeRabbit
New Features
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.