Skip to content

Commit 46c8a57

Browse files
authored
Clarify use of REQUIRED vs RFC 2119 keywords; unify field annotations (#208)
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
1 parent 58b0ca0 commit 46c8a57

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

IETF-RFC.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,9 @@ Open Cloud Mesh only handles the necessary interactions up to the point where th
4444
--- middle
4545

4646
# Terms
47-
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
48-
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and
49-
"OPTIONAL" in this document are to be interpreted as described in
50-
RFC 2119.
47+
The key words "MUST", "MUST NOT", "SHOULD", "SHOULD NOT", and "MAY" in this document are to be interpreted as described in RFC 2119.
48+
49+
The key words "REQUIRED", "RECOMMENDED", "OPTIONAL" has the same meaning as "MUST", "SHOULD" and "MAY" respectively but are used instead of their counterparts where it makes more grammatical sense (such as marking fields in a JSON object).
5150

5251
We define the following concepts (with some non-normative references to related concepts from OAuth and elsewhere):
5352

@@ -267,10 +266,10 @@ itself be an object containing the following fields:
267266
a remote shared resource, implementations MAY use this path
268267
as a prefix, or as the full path (see sharing examples).
269268
* webapp (string) - The top-level path for web apps at this endpoint. This value
270-
is provided for documentation purposes, and it SHALL NOT
269+
is provided for documentation purposes, and it SHOULD NOT
271270
be intended as a prefix for share requests.
272271
* datatx (string) - The top-level path to be used for data transfers. This
273-
value is provided for documentation purposes, and it SHALL
272+
value is provided for documentation purposes, and it SHOULD
274273
NOT be intended as a prefix. In addition, implementations
275274
are expected to execute the transfer using WebDAV as
276275
the wire protocol.
@@ -481,7 +480,7 @@ make a HTTP POST request
481480

482481
## Fields
483482

484-
* REQUIRED notificationType (string) - in a Share Acceptance Notification it SHOULD be one of:
483+
* REQUIRED notificationType (string) - in a Share Acceptance Notification it MUST be one of:
485484
* 'SHARE_ACCEPTED'
486485
* 'SHARE_DECLINED'
487486
* REQUIRED providerId (string) - copied from the Share Creation Notification for the Share this notification is about

0 commit comments

Comments
 (0)