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

format property needs more details #412

Closed
Sakurann opened this issue Feb 4, 2023 · 11 comments · Fixed by #434
Closed

format property needs more details #412

Sakurann opened this issue Feb 4, 2023 · 11 comments · Fixed by #434
Assignees
Milestone

Comments

@Sakurann
Copy link
Contributor

Sakurann commented Feb 4, 2023

I think description of format property in the Presentation Definition object should say that depending on a format, format object must (?) contain alg or proof_type. Otherwise, one needs to go to a claim format registry to find that out (if one can reach the registry).

@bumblefudge
Copy link
Collaborator

sounds like a breaking change I'd rather defer to V3 😉

@Sakurann
Copy link
Contributor Author

it is not breaking. adding text in PE v2.1 saying go to the registry to figure out what objects need to be in formats might do the job.

@bumblefudge
Copy link
Collaborator

I was making a joke because the same week you requested this change, you also requested elsewhere that work not begin on V3 for some time.

I'm not exactly sure, but I'm fairly certain the text you're requesting is here:
https://identity.foundation/presentation-exchange/#claim-format-designations
It was added last July by the illustratively-titled PR #349

If anyone would like to add additional explanatory text to make the situation clearer or the registry easier to reach, such as in the Abstract section or elsewhere, a non-breaking PR is always welcome! This editorial group meets weekly but covers a lot of repos so we have much shorter turnaround for PRs than issues.

@Sakurann
Copy link
Contributor Author

Please reopen the issue. It has not been completed. I filed an issue because i felt like the text you are referring to should be clarified.

Why is it the expectation that a person who finds an issue has to also do a PR? What is the role of the editing team? All the issues that the editing does not have time for get closed?

@nklomp
Copy link
Member

nklomp commented Feb 20, 2023

Agreed

@nklomp nklomp reopened this Feb 20, 2023
@csuwildcat
Copy link
Member

The best way forward is to have the parties requesting a change create a PR that adds whatever they think is needed, then we can pull it in.

@decentralgabe
Copy link
Member

I would also add the format property is not clear. I see two main uses of format:

  • Top level items submitted with a presentation_submission object could be in a number of formats (e.g. ldp_vp, jwt_vp, jwt_vc).
  • In the case of wrapper formats like a *_vp we need a way to constrain the contents of the VP, I believe this format should go on the input_descriptor's format property

So pretty much need a way to say - ok the top level claim may be x, and within that we allow [x, y, z]

@Sakurann
Copy link
Contributor Author

Is there actually a use case where *_vp can have multiple credential formats inside..?

@decentralgabe
Copy link
Member

decentralgabe commented Apr 17, 2023

Is there actually a use case where *_vp can have multiple credential formats inside..?

Yes. A user has a number of credentials from different issuers, of different formats (e.g. an LDP_VC drivers license, a JWT_VC employment verification). They wish to submit them against a Presentation Request in a VP. Probably most of the use cases we intend to support will have this constraint.

@bumblefudge bumblefudge added this to the v2.1 milestone Jun 15, 2023
@bumblefudge bumblefudge self-assigned this Jun 15, 2023
@bumblefudge
Copy link
Collaborator

bumblefudge commented Jun 15, 2023

Agreed on today's call to make a minor text change to clarify that having to check the registry is a feature not a bug and that different claim formats have different required and valid values for each column.

Before closing we will also check JSON Schema examples for alg/proof filtering that might contradict the new language.

@bumblefudge
Copy link
Collaborator

Is there actually a use case where *_vp can have multiple credential formats inside..?

Yes. A user has a number of credentials from different issuers, of different formats (e.g. an LDP_VC drivers license, a JWT_VC employment verification). They wish to submit them against a Presentation Request in a VP. Probably most of the use cases we intend to support will have this constraint.

moved this out to a separate issue (#431) to make sure Kristina's editorial request is treated faster!

bumblefudge pushed a commit that referenced this issue Jun 22, 2023
brentzundel pushed a commit that referenced this issue Aug 17, 2023
* address #412 and #413 explicitly

* reverse fluke overwrite of #422 commit

* reverse fluke overwrite of #422 commit

---------

Co-authored-by: bumblefudge <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment