-
Notifications
You must be signed in to change notification settings - Fork 20
Fix example in implementer overview #266
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
base: main
Are you sure you want to change the base?
Conversation
index.html
Outdated
| For example, a wallet app could resolve <code>did:example:123</code> | ||
| using the `versionTime` resolution option for instance: | ||
| <code>resolve("did:example:123", {"versionTime":"2021-05-10T17:00:00Z"})</code> | ||
| to retrieve the state of that DID at a past time. Or a client could dereference a DID URL | ||
| like <code>did:example:123?service=files&relativeRef=/resume.pdf</code> | ||
| (see <a href="#example-dereferencing-to-service-endpoint-url">here for detailed example</a>) | ||
| to fetch a user's resume stored via a service declared in the DID document. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| For example, a wallet app could resolve <code>did:example:123</code> | |
| using the `versionTime` resolution option for instance: | |
| <code>resolve("did:example:123", {"versionTime":"2021-05-10T17:00:00Z"})</code> | |
| to retrieve the state of that DID at a past time. Or a client could dereference a DID URL | |
| like <code>did:example:123?service=files&relativeRef=/resume.pdf</code> | |
| (see <a href="#example-dereferencing-to-service-endpoint-url">here for detailed example</a>) | |
| to fetch a user's resume stored via a service declared in the DID document. | |
| For example, to retrieve the state of the DID <code>did:example:123</code> | |
| at a past time, a wallet app could resolve the DID with the `versionTime` | |
| resolution option, as in the following:<br> | |
| <code>resolve("did:example:123", {"versionTime":"2021-05-10T17:00:00Z"})</code> | |
| Or, to fetch a user's resume stored via a service declared in the DID | |
| document, a client could dereference a DID URL like this: | |
| <code>did:example:123?service=files&relativeRef=/resume.pdf</code> | |
| (See <a href="#example-dereferencing-to-service-endpoint-url">a more | |
| detailed example</a>.) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given the DID URL Path discussion, we may want to avoid using relativeRef in this example.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @TallTed for the observation on clarity. I will update the PR with your wording on the first example.
Also thanks to @wip-abramson for the observation around the second example using relativeRef. However my PR is not intended to modify that second example. Perhaps we can address in a separate issue after the DID Path discussion is more settled?
b16fbdb to
843a7d8
Compare
…rac/did-resolution into ottomorac-fix-implementer-example
|
Updated PR with changes suggested by @talltree |
| For example, a wallet app could resolve `did:example:123?versionTime=2021-05-10T17:00:00Z` | ||
| using the `versionTime` parameter to retrieve the state of that DID at a past time, or a client could | ||
| For example, to retrieve the state of the DID `did:example:123` | ||
| at a past time, a wallet app could resolve the DID with the `versionTime` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| at a past time, a wallet app could resolve the DID with the `versionTime` | |
| at a past time, a client application could resolve the DID with the `versionTime` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| at a past time, a wallet app could resolve the DID with the `versionTime` | |
| at a time in the past, a client application could resolve the DID with the `versionTime` |
This PR addresses #228, it clarifies the example usage of how to call the resolve function in the Implementer Overview paragraph.
Preview | Diff