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
Examples at different levels serve different purposes, and it is
not clear what is meant by "overriding." Removing this will
allow tools to determine the most appropriate example(s) to show
in a given context.
Copy file name to clipboardExpand all lines: src/oas.md
+3-4Lines changed: 3 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -982,7 +982,7 @@ Note that while `"Cookie"` as a `name` is not forbidden if `in` is `"header"`, t
982
982
983
983
For simpler scenarios, a [`schema`](#parameter-schema) and [`style`](#parameter-style) can describe the structure and syntax of the parameter.
984
984
When `example` or `examples` are provided in conjunction with the `schema` field, the example SHOULD match the specified schema and follow the prescribed serialization strategy for the parameter.
985
-
The `example` and `examples` fields are mutually exclusive, and if either is present it SHALL _override_ any `example` in the schema.
985
+
The `example` and `examples` fields are mutually exclusive.
986
986
987
987
These fields MUST NOT be used with `in: "querystring"`.
988
988
@@ -1242,7 +1242,7 @@ Each Media Type Object describes content structured in accordance with the media
1242
1242
Multiple Media Type Objects can be used to describe content that can appear in any of several different media types.
1243
1243
1244
1244
When `example` or `examples` are provided, the example SHOULD match the specified schema and be in the correct format as specified by the media type and its encoding.
1245
-
The `example` and `examples` fields are mutually exclusive, and if either is present it SHALL _override_ any `example` in the schema.
1245
+
The `example` and `examples` fields are mutually exclusive.
1246
1246
See [Working With Examples](#working-with-examples) for further guidance regarding the different ways of specifying examples, including non-JSON/YAML values.
1247
1247
1248
1248
##### Fixed Fields
@@ -2118,7 +2118,6 @@ The `examples` array is part of JSON Schema and is the preferred way to include
2118
2118
2119
2119
The mutually exclusive fields in the Parameter, Header, or Media Type Objects are used to show example values which SHOULD both match the schema and be formatted as they would appear as a serialized parameter, serialized header, or within a media type representation.
2120
2120
The exact serialization and encoding is determined by various fields in the Parameter Object, Header Object, or in the Media Type Object's [Encoding Object](#encoding-object).
2121
-
Because examples using these fields represent the final serialized form of the data, they SHALL _override_ any `example` in the corresponding Schema Object.
2122
2121
2123
2122
The singular `example` field in the Parameter, Header, or Media Type Object is concise and convenient for simple examples, but does not offer any other advantages over using Example Objects under `examples`.
2124
2123
@@ -2429,7 +2428,7 @@ The `allowReserved` field can disable most but not all of this behavior.
2429
2428
See [Appendix D](#appendix-d-serializing-headers-and-cookies) for details and further guidance.
2430
2429
2431
2430
When `example` or `examples` are provided in conjunction with the `schema` field, the example SHOULD match the specified schema and follow the prescribed serialization strategy for the header.
2432
-
The `example` and `examples` fields are mutually exclusive, and if either is present it SHALL _override_ any `example` in the schema.
2431
+
The `example` and `examples` fields are mutually exclusive.
0 commit comments