-
Notifications
You must be signed in to change notification settings - Fork 41
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 more documentation about the usage of documentLoader
.
#61
Comments
To resolve this issue, we need to see updates to the README for the top-level |
I use this documentLoader in fixtures:
With small amount of cleanup, it might help resolve this issue. When I first started with JSON-LD I spent a lot of time being confused by this. Since a lot of people are trying to work with DIDs, I think the example / documentation should include some opinion on DID Resolvers. |
This is still an issue which is preventing wider adoption of linked data signatures in the DID community. You should provide an example. |
Be especially aware, that if you are relying on https://w3id.org/security/v1 And using a custom document loader, you will need to make sure that these have been updated, to support any properties you are working with.... |
also note that the example I provided above is not correct.... when loading a document of the form:
You should get the same result as:
... examples would really, really, really help here. |
something as simple as:
would go miles. |
I'm kind of popping in on this out of the blue, but I do agree better documentation on documentLoaders should be in each library that provides one. I did not know that vc-js' documentLoader was restricted to just the documents it loads at run time and more frustratingly it does not even expose it's contexts meaning that in order to even get my context to load I had to write a wrapper around the default document loader. There there is the other pitfall which is that a documentLoader returns a context in the following format:
Basically libraries should tell you if their documentLoader will fetch from the internet (most do not) and if not how to add a new context for them to load (usually you just need to set a constant in bedrock). Also one more thing: have we considered making all of the vocabularies / contexts for the project into one github repo? This would allow us to easily see all the potential schemas/ contexts being used in this project and also to create a documentLoader for all those contexts in one place. Anyways love the documentLoader above and good luck on your project. |
I just did this yesterday: https://github.com/decentralized-identity/context For testing interoperability between DID Methods in the Universal Resolver, and JSON-LD Signatures. It is crazy hard to make sense of these things without a consolidated and centralized view as the starting point. |
No description provided.
The text was updated successfully, but these errors were encountered: