You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: versions/3.1.1.md
+17-14Lines changed: 17 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -2775,7 +2775,7 @@ The `readOnly` and `writeOnly` keywords are annotations, as JSON Schema is not a
2775
2775
Validation of these keywords MAY be done by checking the annotation, the read or write direction, and (if relevant) the current value of the field.
2776
2776
[JSON Schema Validation Draft 2020-12 §9.4](https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4) defines the expectations of these keywords, including that a resource (described as the "owning authority") MAY either ignore a `readOnly` field or treat it as an error.
2777
2777
2778
-
An example of where ignoring a "written" `readOnly` field might be appropriate is a PUT request where the field is included but the value has not been changed, since the alternative of leaving out the field would result in the field's deletion per [[RFC7231]].
2778
+
An example of where ignoring a "written" `readOnly` field might be appropriate is a PUT request where the field is included but the value has not been changed, since the alternative of leaving out the field would result in the field's deletion per [[RFC7231]].
2779
2779
2780
2780
Note that the behavior of `readOnly` in particular differs from that specified by version 3.0 of this specification.
2781
2781
@@ -2808,7 +2808,7 @@ An example is included in the "Schema Object Examples" section below, and furthe
2808
2808
2809
2809
The Schema Object's `enum` keyword does not allow associating descriptions or other information with individual values.
2810
2810
2811
-
Implementations MAY support recognizing a `oneOf` or `anyOf` where each subschema in the keyword's array consists of a `const` keyword and annotations such as `title` or `description` as an enumerated type with additional information. The exact behavior of this pattern beyond what is required by JSON Schema is implementation-defined.
2811
+
Implementations MAY support recognizing a `oneOf` or `anyOf` where each subschema in the keyword's array consists of a `const` keyword and annotations such as `title` or `description` as an enumerated type with additional information. The exact behavior of this pattern beyond what is required by JSON Schema is implementation-defined.
2812
2812
2813
2813
###### XML Modeling
2814
2814
@@ -2919,20 +2919,23 @@ additionalProperties:
2919
2919
2920
2920
```json
2921
2921
{
2922
-
"oneOf": [{
2923
-
"const": "RGB",
2924
-
"title": "Red, Green, Blue",
2925
-
"description": "Specify colors with the red, green, and blue additive color model"
2926
-
}, {
2927
-
"const": "CMYK",
2928
-
"title": "Cyan, Magenta, Yellow, Black",
2929
-
"description": "Specify colors with the cyan, magenta, yellow, and black subtractive color model"
2930
-
}]
2922
+
"oneOf": [
2923
+
{
2924
+
"const": "RGB",
2925
+
"title": "Red, Green, Blue",
2926
+
"description": "Specify colors with the red, green, and blue additive color model"
2927
+
},
2928
+
{
2929
+
"const": "CMYK",
2930
+
"title": "Cyan, Magenta, Yellow, Black",
2931
+
"description": "Specify colors with the cyan, magenta, yellow, and black subtractive color model"
2932
+
}
2933
+
]
2931
2934
}
2932
2935
```
2933
2936
2934
2937
```yaml
2935
-
oneOf:
2938
+
oneOf:
2936
2939
- const: RGB
2937
2940
title: Red, Green, Blue
2938
2941
description: Specify colors with the red, green, and blue additive color model
@@ -4520,7 +4523,7 @@ This keeps it outside of the processes governed by this specification.
4520
4523
4521
4524
## Appendix F: Resolving Security Requirements in a Referenced Document
4522
4525
4523
-
This appendix shows how to retrieve an HTTP-accessible multi-document OpenAPI Description (OAD) and resolve a [Security Requirement Object](#security-requirement-object) in the referenced (non-entry) document. See [Resolving Implicit Connections](#resolving-implicit-connections) for more information.
4526
+
This appendix shows how to retrieve an HTTP-accessible multi-document OpenAPI Description (OAD) and resolve a [Security Requirement Object](#security-requirement-object) in the referenced (non-entry) document. See [Resolving Implicit Connections](#resolving-implicit-connections) for more information.
4524
4527
4525
4528
First, the [entry document](#openapi-description-structure) is where parsing begins. It defines the `MySecurity` security scheme to be JWT-based, and it defines a Path Item as a reference to a component in another document:
4526
4529
@@ -4565,7 +4568,7 @@ paths:
4565
4568
$ref: 'other#/components/pathItems/Foo'
4566
4569
```
4567
4570
4568
-
This entry document references another document, `other`, without using a file extension. This gives the client the flexibility to choose an acceptable format on a resource-by-resource basis, assuming both representations are available:
4571
+
This entry document references another document, `other`, without using a file extension. This gives the client the flexibility to choose an acceptable format on a resource-by-resource basis, assuming both representations are available:
0 commit comments