53 lines
1.4 KiB
Python
53 lines
1.4 KiB
Python
|
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}
|