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

* Use RFC 2119 keywords across the content repository spec

* changelog
pull/1869/head
Travis Ralston 6 months ago committed by GitHub
parent 7a51ae879c
commit f38b052569
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

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

@ -200,7 +200,7 @@ paths:
Servers SHOULD prefer to return `image/webp` thumbnails when supporting animation. 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 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 example: false
schema: schema:
type: boolean type: boolean
@ -454,8 +454,8 @@ components:
The maximum number of milliseconds that the client is willing to wait to 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 start receiving data, in the case that the content has not yet been
uploaded. The default value is 20000 (20 seconds). The content uploaded. The default value is 20000 (20 seconds). The content
repository can and should impose a maximum value for this parameter. The repository SHOULD impose a maximum value for this parameter. The
content repository may also choose to respond before the timeout. content repository MAY respond before the timeout.
example: 5000 example: 5000
schema: schema:
type: integer type: integer

@ -401,7 +401,7 @@ paths:
Servers SHOULD prefer to return `image/webp` thumbnails when supporting animation. 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 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 example: false
schema: schema:
type: boolean type: boolean
@ -688,8 +688,8 @@ components:
The maximum number of milliseconds that the client is willing to wait to 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 start receiving data, in the case that the content has not yet been
uploaded. The default value is 20000 (20 seconds). The content uploaded. The default value is 20000 (20 seconds). The content
repository can and should impose a maximum value for this parameter. The repository SHOULD impose a maximum value for this parameter. The
content repository may also choose to respond before the timeout. content repository MAY respond before the timeout.
example: 5000 example: 5000
schema: schema:
type: integer type: integer

@ -137,7 +137,7 @@ paths:
Servers SHOULD prefer to return `image/webp` thumbnails when supporting animation. 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 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 example: false
schema: schema:
type: boolean type: boolean
@ -265,8 +265,8 @@ components:
The maximum number of milliseconds that the client is willing to wait to 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 start receiving data, in the case that the content has not yet been
uploaded. The default value is 20000 (20 seconds). The content uploaded. The default value is 20000 (20 seconds). The content
repository can and should impose a maximum value for this parameter. The repository SHOULD impose a maximum value for this parameter. The
content repository may also choose to respond before the timeout. content repository MAY respond before the timeout.
example: 5000 example: 5000
schema: schema:
type: integer type: integer

Loading…
Cancel
Save