Skip to content

Commit

Permalink
Use RFC 2119 keywords across the content repository spec (#1861)
Browse files Browse the repository at this point in the history
* Use RFC 2119 keywords across the content repository spec

* changelog
  • Loading branch information
turt2live authored Jun 13, 2024
1 parent 7a51ae8 commit f38b052
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 9 deletions.
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/1861.clarification
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Use RFC 2119 keywords more consistently throughout various parts of the specification.
6 changes: 3 additions & 3 deletions data/api/client-server/authed-content-repo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ paths:
Servers SHOULD prefer to return `image/webp` thumbnails when supporting animation.
When `true` and the media cannot be animated, such as in the case of a JPEG or PDF, the
server should behave as though `animated` is `false`.
server SHOULD behave as though `animated` is `false`.
example: false
schema:
type: boolean
Expand Down Expand Up @@ -454,8 +454,8 @@ components:
The maximum number of milliseconds that the client is willing to wait to
start receiving data, in the case that the content has not yet been
uploaded. The default value is 20000 (20 seconds). The content
repository can and should impose a maximum value for this parameter. The
content repository may also choose to respond before the timeout.
repository SHOULD impose a maximum value for this parameter. The
content repository MAY respond before the timeout.
example: 5000
schema:
type: integer
Expand Down
6 changes: 3 additions & 3 deletions data/api/client-server/content-repo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ paths:
Servers SHOULD prefer to return `image/webp` thumbnails when supporting animation.
When `true` and the media cannot be animated, such as in the case of a JPEG or PDF, the
server should behave as though `animated` is `false`.
server SHOULD behave as though `animated` is `false`.
example: false
schema:
type: boolean
Expand Down Expand Up @@ -688,8 +688,8 @@ components:
The maximum number of milliseconds that the client is willing to wait to
start receiving data, in the case that the content has not yet been
uploaded. The default value is 20000 (20 seconds). The content
repository can and should impose a maximum value for this parameter. The
content repository may also choose to respond before the timeout.
repository SHOULD impose a maximum value for this parameter. The
content repository MAY respond before the timeout.
example: 5000
schema:
type: integer
Expand Down
6 changes: 3 additions & 3 deletions data/api/server-server/content_repository.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ paths:
Servers SHOULD prefer to return `image/webp` thumbnails when supporting animation.
When `true` and the media cannot be animated, such as in the case of a JPEG or PDF, the
server should behave as though `animated` is `false`.
server SHOULD behave as though `animated` is `false`.
example: false
schema:
type: boolean
Expand Down Expand Up @@ -265,8 +265,8 @@ components:
The maximum number of milliseconds that the client is willing to wait to
start receiving data, in the case that the content has not yet been
uploaded. The default value is 20000 (20 seconds). The content
repository can and should impose a maximum value for this parameter. The
content repository may also choose to respond before the timeout.
repository SHOULD impose a maximum value for this parameter. The
content repository MAY respond before the timeout.
example: 5000
schema:
type: integer
Expand Down

0 comments on commit f38b052

Please sign in to comment.