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 RFC 2119 keywords across the content repository spec #1861

Merged
merged 2 commits into from
Jun 13, 2024
Merged

Use RFC 2119 keywords across the content repository spec #1861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ed8f53
Use RFC 2119 keywords across the content repository spec
turt2live Jun 11, 2024
bd33ac2
changelog
turt2live Jun 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/1861.clarification
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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