Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add schema type metadata #231

Merged
merged 15 commits into from
Jul 8, 2024
Merged

Add schema type metadata #231

merged 15 commits into from
Jul 8, 2024

Conversation

awoie
Copy link
Collaborator

@awoie awoie commented May 14, 2024

This PR includes the following:

  • Add schema type metadata
  • Add full schema type metadata examples
  • Describe base document for schema validation
  • Minor editorial fixes
  • Moved type metadata retrieval section for readability purposes
  • IANA considerations for schema, schema_uri and schema_uri#integrity

See preview here:
https://drafts.oauth.net/oauth-sd-jwt-vc/awoie/fix-229-schema/draft-ietf-oauth-sd-jwt-vc.html

Fixes #229

@awoie
Copy link
Collaborator Author

awoie commented May 14, 2024

@danielfett @bc-pi Do you think it makes sense to describe the base document for schema type metadata validation? For example, a verifier receiving an SD-JWT VC with Disclosures won't be able to validate the JSON schema against it before transforming the entire SD-JWT VC with Disclosures to expanded JSON document first.

@awoie
Copy link
Collaborator Author

awoie commented May 14, 2024

@danielfett @bc-pi Should we restrict schema to specific JSON schema versions?

draft-ietf-oauth-sd-jwt-vc.md Outdated Show resolved Hide resolved
draft-ietf-oauth-sd-jwt-vc.md Outdated Show resolved Hide resolved
draft-ietf-oauth-sd-jwt-vc.md Outdated Show resolved Hide resolved
Co-authored-by: Daniel Fett <fett@danielfett.de>
@bc-pi
Copy link
Collaborator

bc-pi commented May 19, 2024

@danielfett @bc-pi Should we restrict schema to specific JSON schema versions?

I'm honestly not familiar with the intricacies of JSON schema. Is/are there a stable standard version(s) that can be referenced from a prospective RFC? The current content of the PR seems to have some normative statements but no reference. I'd think that's kind of a prerequisite to discussing version restrictions/requirements.

A few minutes of looking around and I found this https://json-schema.org/specification-links which at least suggests it's a bit messy.

Any idea if/how other actual standards documents utilize JSON schema?

@bc-pi
Copy link
Collaborator

bc-pi commented May 19, 2024

@danielfett @bc-pi Do you think it makes sense to describe the base document for schema type metadata validation? For example, a verifier receiving an SD-JWT VC with Disclosures won't be able to validate the JSON schema against it before transforming the entire SD-JWT VC with Disclosures to expanded JSON document first.

Well, statements like "MUST validate the Verifiable Credential against the provided JSON Schema document." probably need some more clarity about what part of the VC and at what stage of transformation/processing.

@danielfett
Copy link
Member

A few minutes of looking around and I found this https://json-schema.org/specification-links which at least suggests it's a bit messy.

Any idea if/how other actual standards documents utilize JSON schema?

I suggest that we proceed with merging this PR nonetheless and have a separate discussion on JSON Schema versions in an issue.

@awoie
Copy link
Collaborator Author

awoie commented Jun 11, 2024

Update: We don't need IANA registration for schema, schema_uri and schema_uri#integrity since type metadata is not a JWT.

@awoie awoie marked this pull request as ready for review July 1, 2024 15:19
@awoie
Copy link
Collaborator Author

awoie commented Jul 1, 2024

@bc-pi @danielfett Can you please check the examples I added.

@awoie awoie requested review from danielfett, bc-pi and oed July 1, 2024 15:20
@awoie
Copy link
Collaborator Author

awoie commented Jul 1, 2024

@bc-pi @danielfett Can you please check the examples I added.

I believe we will need to distinguish between presentation and issuance schemas -> see #237

draft-ietf-oauth-sd-jwt-vc.md Outdated Show resolved Hide resolved
@bc-pi
Copy link
Collaborator

bc-pi commented Jul 1, 2024

@bc-pi @danielfett Can you please check the examples I added.

I don't really speak JSON schema but it looks ok

Copy link
Member

@danielfett danielfett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left a couple of editorial remarks, but generally this looks good to me, thank you!

draft-ietf-oauth-sd-jwt-vc.md Outdated Show resolved Hide resolved
draft-ietf-oauth-sd-jwt-vc.md Outdated Show resolved Hide resolved
draft-ietf-oauth-sd-jwt-vc.md Outdated Show resolved Hide resolved
draft-ietf-oauth-sd-jwt-vc.md Outdated Show resolved Hide resolved
awoie and others added 5 commits July 8, 2024 08:46
Co-authored-by: Daniel Fett <fett@danielfett.de>
Co-authored-by: Daniel Fett <fett@danielfett.de>
Co-authored-by: Daniel Fett <fett@danielfett.de>
Co-authored-by: Daniel Fett <fett@danielfett.de>
@awoie
Copy link
Collaborator Author

awoie commented Jul 8, 2024

left a couple of editorial remarks, but generally this looks good to me, thank you!

Thanks a lot. I updated the PR. Will merge later on the editor's call.

@awoie
Copy link
Collaborator Author

awoie commented Jul 8, 2024

Merging this since all comments were addressed.

@bc-pi bc-pi merged commit ec6d9b9 into main Jul 8, 2024
2 checks passed
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.

Schema for type metadata
4 participants