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 example for Verification Method ID as a fragment #860

Open
wip-abramson opened this issue Aug 22, 2024 · 4 comments
Open

Add example for Verification Method ID as a fragment #860

wip-abramson opened this issue Aug 22, 2024 · 4 comments
Labels
class 2 Changes that do not functionally affect interpretation of the document ready for pr Issue is ready for a PR

Comments

@wip-abramson
Copy link

For example

{
      "id": "#key-3",
      "type": "JsonWebKey2020",
      "controller": "did:example:123",
      "publicKeyJwk": {
        "kty": "EC", // external (property name)
        "crv": "secp256k1", // external (property name)
        "x": "U1V4TVZVMUpUa0ZVU1NBcU9CRm5IbmFaaEpGNkxkdWx", // external (property name)
        "y": "i5a2NtJoUKXkLm6q8nOEu9WOkso1Ag6FTUT6k_LMnGk" // external (property name)
    }
}

My understanding was that this was possible, but reading the spec I am not not sure.

The spec states for the id property:

The value of the id property for a verification method MUST be a string that conforms to the rules in Section 3.2 DID URL Syntax.

The did-url ABNF is below.

did-url = did path-abempty [ "?" query ] [ "#" fragment ]
@decentralgabe
Copy link
Contributor

See 3.2.2. Relative DID URLs

Relative DID URLs are often used to reference verification methods and services in a DID Document without having to use absolute URLs. DID methods where storage size is a consideration might use relative URLs to reduce the storage size of DID documents.

It would be helpful to add references to this section

@decentralgabe decentralgabe added the question Further information is requested label Aug 22, 2024
@wip-abramson
Copy link
Author

Ah great, I missed that. Think this can be closed, unless you are suggesting we should update the references?

I think it is in there, as it references 3.2 which includes 3.2.2. I just didn't read far enough down, my bad.

One thing we might consider is adding an example that uses relative DID-URLs to section A.

@decentralgabe
Copy link
Contributor

I believe an example would be useful...it took me a few minutes to find the section.

@msporny msporny added ready for pr Issue is ready for a PR class 2 Changes that do not functionally affect interpretation of the document and removed question Further information is requested labels Oct 31, 2024
@msporny msporny changed the title Can Verification Method Ids be fragments? Add example for Verification Method ID as a fragment Oct 31, 2024
@wip-abramson
Copy link
Author

Happy to submit a PR for this. Would you prefer a new example, or should I just modify an existing one to include relative URLs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
class 2 Changes that do not functionally affect interpretation of the document ready for pr Issue is ready for a PR
Projects
None yet
Development

No branches or pull requests

3 participants