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

normative statements: JSON and JSON-LD representations sections #436

Merged
merged 4 commits into from
Oct 26, 2020

Conversation

rhiaro
Copy link
Member

@rhiaro rhiaro commented Oct 13, 2020

Some rearranging of normative statements to more appropriate places, and removal where redundant (in intro/advisory sections). More detailed explanations of each in commits. #384


Preview | Diff

Removes duplicate normative statements in introductory text in
favour of more precise statements in the paragraphs which follow
in the JSON and JSON-LD representation sections.

Also fixes some spacing and formatting.
Normative requirements about dereferencing and and hashing contents
of @context URIs are requirements on a producer rather than a
consumer, so these statements have been moved accordingly. (#384)

Also removes normative language around conforming to JSON-LD
production rules as this is not a requirement on the consumer, but
advisory.
@rhiaro rhiaro force-pushed the rhiaro-384-normative-statements-representations-2 branch from 6c6a29c to bd9c247 Compare October 13, 2020 13:18
index.html Outdated Show resolved Hide resolved
Copy link
Member

@brentzundel brentzundel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor nit, otherwise LGTM

index.html Outdated Show resolved Hide resolved
Co-authored-by: Brent Zundel <[email protected]>
@rhiaro rhiaro requested a review from OR13 October 18, 2020 18:21
It is RECOMMENDED that dereferencing each <a>URI</a> value of the
<code>@context</code> property results in a document containing
machine-readable information about the context. These URIs SHOULD be
associated with a cryptographic hash of the content of the JSON-LD Context as
Copy link
Member

@kdenhartog kdenhartog Oct 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just now noticing this portion of text. Looks like it was in here before though. Do we need to say anything more about how this cryptographic hash should be associated? I'm thinking what sort of format should it be provided (e.g. hashlink, multiformat, etc) as well as what sorts of restrictions do we want to say about the hash used (e.g. MD5 or sha-1 acceptable?)

These are nitpick details that I wasn't sure if it would be better to put in here or in the did-spec-registries document. I can file the issue in the appropriate place so we can follow up on this in a subsequent separate discussion.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, and think this should go in the Registries. See also: w3c/did-extensions#146

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm in favor of either specifying a single hash format or removing these recommendations... this is creating complexity which I doubt it adding any value... and of course, you can just use IPFS URLs if you are concerned about this.

@msporny
Copy link
Member

msporny commented Oct 26, 2020

Normative, multiple positive reviews, changes requested and made, no objections, merging.

@msporny msporny merged commit 2a3ca5d into master Oct 26, 2020
@msporny msporny deleted the rhiaro-384-normative-statements-representations-2 branch November 8, 2020 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants