Skip to content

Fix respec-oas RENDER ERROR on Credential/Presentation schemas - #691

Draft
PatStLouis wants to merge 1 commit into
w3c:mainfrom
OpSecId:fix/respec-oas-allof-type-object
Draft

Fix respec-oas RENDER ERROR on Credential/Presentation schemas#691
PatStLouis wants to merge 1 commit into
w3c:mainfrom
OpSecId:fix/respec-oas-allof-type-object

Conversation

@PatStLouis

Copy link
Copy Markdown
Collaborator

Summary

  • respec-oas@1.0.1 fails to render property schemas that use allOf without a top-level type (falls through to RENDER ERROR and dumps the JSON schema).
  • The published TR shows 12 of these errors; all resolve to four role wrappers: Credential, VerifiableCredential, Presentation, VerifiablePresentation.
  • Add type: object beside each allOf so the renderer takes the object path and merges allOf properties. Shared CredentialDocument / PresentationDocument bases are unchanged.

Affected endpoints (all 12 cells)

  1. §3.2.1 Issue Credential — credential
  2. §3.3.1 Verify Credential — verifiableCredential
  3. §3.3.2 Verify Presentation — verifiablePresentation
  4. §3.3.2 Verify Presentation — presentation
  5. §3.5.1 Derive Credential — verifiableCredential
  6. §3.5.2 Create Presentation — presentation
  7. §3.6.1 Create Workflow — nested under steps
  8. §3.6.2 Get Workflow Configuration — 200
  9. §3.6.5 Participate in an Exchange — verifiablePresentation
  10. §3.6.5 Participate in an Exchange — 200
  11. §3.6.6 Get Exchange State — 200
  12. Appendix C.1 Create Status List — 201

Test plan

  • Open editor's draft / local npm run serve and confirm the 12 property tables no longer show RENDER ERROR
  • Spot-check Issue Credential / Verify Presentation tables show @context and type from the document schemas
  • npm run lint (OpenAPI) still passes

Made with Cursor

Add type: object to the allOf role wrappers so respec-oas can render property tables for Credential, VerifiableCredential, Presentation, and VerifiablePresentation (clears all 12 TR table errors).

Co-authored-by: Cursor <cursoragent@cursor.com>
@eric-schuh

eric-schuh commented Aug 4, 2026

Copy link
Copy Markdown
Collaborator

I think we ended up fixing the same issue in different ways @PatStLouis, I had just opened a PR on the respec-oas repo to fix these bugs here: w3c-ccg/respec-oas#5

Your solution is likely the better one as it doesn't involve a respec-oas update, that is unless this is a pattern we don't want to have to worry about in the future with other specification that also use respec1.0.1 and the above pattern.

@PatStLouis

Copy link
Copy Markdown
Collaborator Author

Discussed: the group will wait until the respec fix is pushed upstream, if issues are resolved, this PR may be closed

@PatStLouis

Copy link
Copy Markdown
Collaborator Author

Discussed: after #706 has been merge, revisit the spec and see if this fix is still needed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants