Clarify and align normative language #208
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit aligns the document with RFC 2119 terminology by distinguishing between normative keywords ("MUST", "SHOULD", etc.) and descriptive field annotations ("REQUIRED", "OPTIONAL"). Specifically:
- Introduces an explanatory note in the "Terms" section about the semantic equivalence of "REQUIRED", "RECOMMENDED", and "OPTIONAL" to "MUST", "SHOULD", and "MAY", respectively.
- Updates inconsistent "SHOULD be one of" to "MUST be one of" for enumerated value fields where appropriate.
Closes: #206
mickenordin
force-pushed
the
kano-cleanup
branch
from
60cba8d to
323e473
Compare
MahdiBaghbani
approved these changes
Jul 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Clarify use of REQUIRED vs RFC 2119 keywords; unify field annotations
This PR addresses specification language consistency as described in Issue #206. The goal is to clearly distinguish between normative keywords (used for protocol behavior) and field annotations (used for JSON schema documentation)
✅ Summary of Changes
📝 Terms section clarified:
"REQUIRED","RECOMMENDED", and"OPTIONAL"are semantically equivalent to"MUST","SHOULD", and"MAY"but used for readability in JSON object fields.🔄 Field annotation harmonization:
"SHOULD be one of"to"MUST be one of"in enumerated values where the value space is normative.📌 Rationale
This change improves:
Closes: #206