38 lines
1.1 KiB
Python
38 lines
1.1 KiB
Python
|
from openapi_pydantic.compat import PYDANTIC_V2, ConfigDict, Extra
|
||
|
|
|
||
|
|
from .parameter import ParameterBase
|
||
|
|
|
||
|
|
_examples = [
|
||
|
|
{
|
||
|
|
"description": "The number of allowed requests in the current period",
|
||
|
|
"schema": {"type": "integer"},
|
||
|
|
}
|
||
|
|
]
|
||
|
|
|
||
|
|
|
||
|
|
class Header(ParameterBase):
|
||
|
|
"""
|
||
|
|
The Header Object follows the structure of the
|
||
|
|
[Parameter Object](#parameterObject) with the following changes:
|
||
|
|
|
||
|
|
1. `name` MUST NOT be specified, it is given in the corresponding
|
||
|
|
`headers` map.
|
||
|
|
2. `in` MUST NOT be specified, it is implicitly in `header`.
|
||
|
|
3. All traits that are affected by the location MUST be applicable
|
||
|
|
to a location of `header` (for example, [`style`](#parameterStyle)).
|
||
|
|
"""
|
||
|
|
|
||
|
|
if PYDANTIC_V2:
|
||
|
|
model_config = ConfigDict(
|
||
|
|
extra="allow",
|
||
|
|
populate_by_name=True,
|
||
|
|
json_schema_extra={"examples": _examples},
|
||
|
|
)
|
||
|
|
|
||
|
|
else:
|
||
|
|
|
||
|
|
class Config:
|
||
|
|
extra = Extra.allow
|
||
|
|
allow_population_by_field_name = True
|
||
|
|
schema_extra = {"examples": _examples}
|