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

Verification algorithm drops an input map on the floor #1518

Closed
jyasskin opened this issue Jul 1, 2024 · 4 comments
Closed

Verification algorithm drops an input map on the floor #1518

jyasskin opened this issue Jul 1, 2024 · 4 comments
Assignees
Labels
CR1 This item was processed during CR1 editorial Purely editorial changes to the specification. pr exists

Comments

@jyasskin
Copy link
Member

jyasskin commented Jul 1, 2024

https://w3c.github.io/vc-data-model/#verification says

This algorithm takes inputs of a media type (string inputMediaType) paired with either a sequence of bytes (byte sequence inputBytes) or a document (map inputDocument)

But inputDocument is never mentioned again in the rest of the algorithm.

@msporny msporny added editorial Purely editorial changes to the specification. CR1 This item was processed during CR1 labels Jul 3, 2024
@msporny msporny self-assigned this Jul 3, 2024
@msporny
Copy link
Member

msporny commented Jul 3, 2024

Yeah, we'll have to clean that up. There was an implementer comment that noted that they allowed input documents as well as input bytes and wanted that to be highlighted in the algorithm (to make sure people knew that it's fine to pass in either and libraries could deal with either).

The challenge here is that the algorithms can be implemented in any way that a developer would like to implement them (as long as the final result is the same). I'm not sure we need to document every variation, but at the same time, some developers are concerned that their implementation will be viewed as "non-conforming" if they don't follow the algorithms closely.

I'll try to see how we can balance the two desires with the spec text.

@msporny msporny added the ready for PR This issue is ready for a Pull Request to be created to resolve it label Jul 3, 2024
@jyasskin
Copy link
Member Author

jyasskin commented Jul 3, 2024

Thinking about how to express that concern in the spec ... it's the application as a whole that'd be conforming or not, but you're right that it's useful for libraries to be able to say "call me to make your application conform to VC." You could have the first step be

1. Let _inputDocument_ be the result of [=parsing JSON bytes to an Infra value=] given _inputBytes_.

    Note: Libraries that implement this specification might leave this step to the calling application.

(I considered making that a normative "Libraries ... may ...", but you don't have a conformance class for libraries.)

@msporny
Copy link
Member

msporny commented Jul 6, 2024

PR #1523 has been raised to address this issue. This issue will be closed once PR #1523 has been merged.

@msporny msporny added pr exists and removed ready for PR This issue is ready for a Pull Request to be created to resolve it labels Jul 6, 2024
@msporny
Copy link
Member

msporny commented Jul 15, 2024

PR #1523 has been merged, closing.

@msporny msporny closed this as completed Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CR1 This item was processed during CR1 editorial Purely editorial changes to the specification. pr exists
Projects
None yet
Development

No branches or pull requests

2 participants