Adding upstream version 0.5.1.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
303fa6e9d8
commit
97e6d74bac
110 changed files with 12006 additions and 0 deletions
36
openapi_pydantic/v3/v3_1/external_documentation.py
Normal file
36
openapi_pydantic/v3/v3_1/external_documentation.py
Normal file
|
@ -0,0 +1,36 @@
|
|||
from typing import Optional
|
||||
|
||||
from pydantic import BaseModel
|
||||
|
||||
from openapi_pydantic.compat import PYDANTIC_V2, ConfigDict, Extra
|
||||
|
||||
_examples = [{"description": "Find more info here", "url": "https://example.com"}]
|
||||
|
||||
|
||||
class ExternalDocumentation(BaseModel):
|
||||
"""Allows referencing an external resource for extended documentation."""
|
||||
|
||||
description: Optional[str] = None
|
||||
"""
|
||||
A short description of the target documentation.
|
||||
[CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text
|
||||
representation.
|
||||
"""
|
||||
|
||||
url: str
|
||||
"""
|
||||
**REQUIRED**. The URL for the target documentation.
|
||||
Value MUST be in the form of a URL.
|
||||
"""
|
||||
|
||||
if PYDANTIC_V2:
|
||||
model_config = ConfigDict(
|
||||
extra="allow",
|
||||
json_schema_extra={"examples": _examples},
|
||||
)
|
||||
|
||||
else:
|
||||
|
||||
class Config:
|
||||
extra = Extra.allow
|
||||
schema_extra = {"examples": _examples}
|
Loading…
Add table
Add a link
Reference in a new issue