Skip to content

Commit cda2ba7

Browse files
handrewsjdesrosiers
andcommitted
Clarify discriminator + oneOf/anyOf/allOf usage (3.2.0)
This moves some guidance up to the fixed fields section where it is more obvious, and explicitly designates other configurations as having undefined behavior. It also creates subsections to organize the different topics, pulls key guidance out of the examples and up into those sections, and provides clarification on the ambiguity of names and URIs. Finally, it incorporates ideas from @jdesrosiers regarding the ambiguous `mapping` syntax submitted in a prior PR, but does so in a way that meets our compatibility requirements for patch releases. For the same compatibility reasons, the MUST wording for requiring the named discriminator property in the schema was (regrettably) weakened to a "SHOULD but otherwise undefined", as we have done for other problematic ambiguities. Co-authored-by: Jason Desrosiers <[email protected]>
1 parent e723bf9 commit cda2ba7

File tree

1 file changed

+31
-10
lines changed

1 file changed

+31
-10
lines changed

versions/3.2.0.md

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,10 @@ An OpenAPI document MAY be made up of a single document or be divided into multi
153153

154154
It is RECOMMENDED that the root OpenAPI document be named: `openapi.json` or `openapi.yaml`.
155155

156+
#### <a name="resolvingImplicitConnections"></a>Resolving Implicit Connections
157+
158+
***TODO: In another PR***
159+
156160
### <a name="dataTypes"></a>Data Types
157161

158162
Data types in the OAS are based on the types supported by the [JSON Schema Specification Draft 2020-12](https://tools.ietf.org/html/draft-bhutton-json-schema-00#section-4.2.1).
@@ -2887,19 +2891,38 @@ components:
28872891
28882892
#### <a name="discriminatorObject"></a>Discriminator Object
28892893
2890-
When request bodies or response payloads may be one of a number of different schemas, a `discriminator` object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the document of an alternative schema based on the value associated with it.
2891-
2892-
When using the discriminator, _inline_ schemas will not be considered.
2894+
When request bodies or response payloads may be one of a number of different schemas, a Discriminator Object gives a hint about the expected schema of the document.
2895+
This hint can be used to aid in serialization, deserialization, and validation.
2896+
The Discriminator Object does this by implicitly or explicitly associating the possible values of a named property with alternative schemas.
28932897
28942898
##### Fixed Fields
28952899
Field Name | Type | Description
28962900
---|:---:|---
2897-
<a name="propertyName"></a>propertyName | `string` | **REQUIRED**. The name of the property in the payload that will hold the discriminator value.
2898-
<a name="discriminatorMapping"></a> mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or references.
2901+
<a name="propertyName"></a>propertyName | `string` | **REQUIRED**. The name of the property in the payload that will hold the discriminator value. This property SHOULD be required in the payload schema, as the behavior when the property is absent is undefined.
2902+
<a name="discriminatorMapping"></a> mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or URI references.
28992903

29002904
This object MAY be extended with [Specification Extensions](#specificationExtensions).
29012905

2902-
The discriminator object is legal only when using one of the composite keywords `oneOf`, `anyOf`, `allOf`. Note that because the discriminating property's value is used as a component name and/or as the key in the `mapping` object, the behavior of any value that is not a string is undefined.
2906+
##### Conditions for Using the Discriminator Object
2907+
The Discriminator Object is legal only when using one of the composite keywords `oneOf`, `anyOf`, `allOf`.
2908+
In both the `oneOf` and `anyOf` use cases, where those keywords are adjacent to `discriminator`, all possible schemas MUST be listed explicitly.
2909+
To avoid redundancy, the discriminator MAY be added to a parent schema definition, and all schemas building on the parent schema via an `allOf` construct may be used as an alternate schema.
2910+
2911+
The behavior of any configuration of `oneOf`, `anyOf`, `allOf` and `discriminator` that is not described above is undefined.
2912+
2913+
##### Options for Mapping Values to Schemas
2914+
The value of the property named in `propertyName` is used as the name of the associated schema under the [Components Object](#componentsObject), _unless_ a `mapping` is present for that value.
2915+
The `mapping` entry maps a specific property value to either a different schema component name, or to a schema identified by a URI.
2916+
When using implicit or explicit schema component names, inline `oneOf` or `anyOf` subschemas are not considered.
2917+
The behavior of a `mapping` value that is both a valid schema name and a valid relative URI reference is implementation-defined, but it is RECOMMENDED that it be treated as a schema name.
2918+
To ensure that an ambiguous value (e.g. `"foo"`) is treated as a relative URI reference by all implementations, authors MUST prefix it with the `"."` path segment (e.g. `"./foo"`).
2919+
2920+
Mapping keys MUST be string values, but tooling MAY convert response values to strings for comparison.
2921+
However, the exact nature of such conversions are implementation-defined.
2922+
2923+
##### <a name="discriminatorExamples"></a>Examples
2924+
2925+
For these examples, assume all schemas are in the entry OpenAPI document; for handling of `discriminator` in referenced documents see [Resolving Implicit Connections](#resolvingImplicitConnections).
29032926

29042927
In OAS 3.0, a response payload MAY be described to be exactly one of any number of types:
29052928

@@ -2951,13 +2974,11 @@ MyResponseType:
29512974
monster: https://gigantic-server.com/schemas/Monster/schema.json
29522975
```
29532976

2954-
Here the discriminator _value_ of `dog` will map to the schema `#/components/schemas/Dog`, rather than the default (implicit) value of `Dog`. If the discriminator _value_ does not match an implicit or explicit mapping, no schema can be determined and validation SHOULD fail. Mapping keys MUST be string values, but tooling MAY convert response values to strings for comparison.
2977+
Here the discriminator property _value_ of `dog` will map to the schema `#/components/schemas/Dog`, rather than the default (implicit) value of `#/components/schemas/dog`. If the discriminator property _value_ does not match an implicit or explicit mapping, no schema can be determined and validation SHOULD fail.
29552978

29562979
When used in conjunction with the `anyOf` construct, the use of the discriminator can avoid ambiguity where multiple schemas may satisfy a single payload.
29572980

2958-
In both the `oneOf` and `anyOf` use cases, all possible schemas MUST be listed explicitly. To avoid redundancy, the discriminator MAY be added to a parent schema definition, and all schemas comprising the parent schema in an `allOf` construct may be used as an alternate schema.
2959-
2960-
For example:
2981+
This example shows the `allOf` usage, which avoids needing to reference all child schemas in the parent:
29612982

29622983
```yaml
29632984
components:

0 commit comments

Comments
 (0)