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.

Sign up for GitHub

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

Jump to bottom

Use of RFC2119 language #35

Closed
zimeon opened this issue Jul 18, 2018 · 5 comments
Closed

Use of RFC2119 language #35

zimeon opened this issue Jul 18, 2018 · 5 comments
Labels
Decided An editorial decision that was decided Editorial Editorial issues (no changes to intent)
Milestone
Alpha

Comments

@zimeon
Copy link
Contributor

zimeon commented Jul 18, 2018 •
edited
Loading

What words from rfc2119 will we use? Also need to add note and normative ref to spec.
@zimeon zimeon mentioned this issue Jul 18, 2018
Merged
@zimeon zimeon added the Editorial Editorial issues (no changes to intent) label Jul 18, 2018
@zimeon
Copy link
Contributor Author

zimeon commented Jul 18, 2018

I note that there is an update https://tools.ietf.org/html/rfc8174

@zimeon
Copy link
Contributor Author

zimeon commented Jul 18, 2018

I note that in the Fedora API spec we adopted only a subset of the RFC2119 keywords:

The key words MAY, MUST, MUST NOT, SHOULD AND SHOULD NOT are to be interpreted as described in RFC2119.

@ahankinson
Copy link
Contributor

From what I can tell, respec gathers these automatically and updates the docs accordingly.

Compare:

https://github.com/fcrepo/fcrepo-specification/blob/master/index.html#L111-L117

with

https://fedora.info/2018/06/25/spec/#conformance

@zimeon
Copy link
Contributor Author

zimeon commented Jul 18, 2018

Proposal from 2018-07-18 editors' call: we will limit ourselves to the minimal subset of MAY, MUST, MUST NOT, SHOULD and SHOULD NOT. We will avoid the variations such as RECOMMENDED which has the same weight as SHOULD per rfc2119. There is no need to add anything to the spec as reSpec automagically does this for us.

ahankinson added a commit that referenced this issue Jul 19, 2018
@ahankinson
Fixed: Use agreed language per RFC2119
d606a83 
Refs #35
ahankinson added a commit that referenced this issue Jul 19, 2018
@ahankinson
Fixed: Update language per RFC2119
569d82f 
Refs #35
@ahankinson ahankinson mentioned this issue Jul 19, 2018
Merged
awoods pushed a commit that referenced this issue Jul 19, 2018
@ahankinson
New: Added section on digest algorithm (#36)
8c25a8b 
* New: Added section on digest algorithm

Added a section on digest algorithm choice.

Refs #8

* Fixed: Use agreed language per RFC2119

Refs #35

* Fixed: Added SHA512 to table listing hash algorithms
@zimeon
Copy link
Contributor Author

zimeon commented Aug 1, 2018

Agreed: we will limit ourselves to the minimal subset of MAY, MUST, MUST NOT, SHOULD and SHOULD NOT

@zimeon zimeon closed this as completed Aug 1, 2018
@ahankinson ahankinson added the Decided An editorial decision that was decided label Aug 15, 2018
@zimeon zimeon added this to the Alpha milestone Oct 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Decided An editorial decision that was decided Editorial Editorial issues (no changes to intent)
Projects
None yet
Milestone
Alpha
Development

No branches or pull requests
2 participants
@ahankinson @zimeon