Skip to content

Commit

Permalink
Remove defined term from "required"
Browse files Browse the repository at this point in the history
- Also remove duplicate phrasing paragraph for JSON convention used
  • Loading branch information
thadguidry committed Apr 16, 2024
1 parent 95e7373 commit 7ed0869
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions draft/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -257,32 +257,29 @@ <h2>Core Concepts</h2>
</p>
<h3 data-link-for="conventions">Terms Used</h3>
<p>
<b>JSON</b> [[RFC8259]] format conventions are used throughout this document, including examples.
</p>
<p>
The following concepts are used and borrowed from JSON syntax as well as from [[RFC2119]]:
The following concepts are used and borrowed from JSON [[RFC8259]] syntax as well as from [[RFC2119]]:
<ul>
<li>
<dfn
data-lt="key|keyword|fields">
field
</dfn> is the alternative term used throughout to refer to the key or name part in a <code>"name":"value"</code> pair in a JSON object as defined by [[RFC8259]].
</dfn> is the alternative term used throughout to refer to the key or name part in a <code>{"name":"value"}</code> pair in a JSON object as defined by [[RFC8259]].
Or more loosely, a "key" in JSON data. The typical convention when dealing with APIs or programmatic querying of
records is to use "fields" rather than "keys", so we have chosen to use that term in this specification
records is to use the term "fields" rather than "keys", so we have chosen to use that term in this specification
when speaking of objects to query/request or respond with.
</li>
<li>
<dfn
data-lt="MANDATORY|NON-OPTIONAL">
required
</dfn> is the default and might be used at times to signify those [=fields=] which are mandatory and MUST be used in all reconciliation services.
<!-- "required" is not a defined term since it is a default and unused currently.
So, we just make it bold italics to provide a similar style as defined terms.
-->
( <b><i>required</i></b> ) is the default and might be used at times to signify those [=fields=] which are mandatory and MUST be used in all reconciliation services.
If the field is not specified as either REQUIRED or OPTIONAL, then it is REQUIRED.
</li>
<li>
<dfn
(<dfn
data-lt="NOT MANDATORY|NON-MANDATORY">
optional
</dfn> is used to signify those [=fields=] which are not mandatory and MAY be used.
</dfn>) is used to signify those [=fields=] which are not mandatory and MAY be used.
</li>
</ul>
</p>
Expand Down

0 comments on commit 7ed0869

Please sign in to comment.