wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Use RFC 2119 keywords across the content repository spec (#1861)

Browse source 
* Use RFC 2119 keywords across the content repository spec

* changelog
This commit is contained in:
Travis Ralston 2024-06-13 12:27:06 -06:00 • committed by GitHub
parent 7a51ae879c
commit f38b052569
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 10 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/1861.clarification Normal file
View file

@ -0,0 +1 @@
Use RFC 2119 keywords more consistently throughout various parts of the specification.

6
data/api/client-server/authed-content-repo.yaml
View file

@ -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
@ -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

6
data/api/client-server/content-repo.yaml
View file

@ -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
@ -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

6
data/api/server-server/content_repository.yaml
View file

@ -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
@ -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