1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
from typing import Dict, Optional
from pydantic import BaseModel
from openapi_pydantic.compat import PYDANTIC_V2, ConfigDict, Extra
_examples = [
{
"propertyName": "petType",
"mapping": {
"dog": "#/components/schemas/Dog",
"monster": "https://gigantic-server.com/schemas/Monster/schema.json",
},
}
]
class Discriminator(BaseModel):
"""
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 specification of an alternative schema based on the value
associated with it.
When using the discriminator, _inline_ schemas will not be considered.
"""
propertyName: str
"""
**REQUIRED**. The name of the property in the payload that will hold the
discriminator value.
"""
mapping: Optional[Dict[str, str]] = None
"""
An object to hold mappings between payload values and schema names or references.
"""
if PYDANTIC_V2:
model_config = ConfigDict(
extra="allow",
json_schema_extra={"examples": _examples},
)
else:
class Config:
extra = Extra.allow
schema_extra = {"examples": _examples}
|
