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
67
openapi_pydantic/v3/v3_0/server.py
Normal file
67
openapi_pydantic/v3/v3_0/server.py
Normal file
|
@ -0,0 +1,67 @@
|
|||
from typing import Dict, Optional
|
||||
|
||||
from pydantic import BaseModel
|
||||
|
||||
from openapi_pydantic.compat import PYDANTIC_V2, ConfigDict, Extra
|
||||
|
||||
from .server_variable import ServerVariable
|
||||
|
||||
_examples = [
|
||||
{
|
||||
"url": "https://development.gigantic-server.com/v1",
|
||||
"description": "Development server",
|
||||
},
|
||||
{
|
||||
"url": "https://{username}.gigantic-server.com:{port}/{basePath}",
|
||||
"description": "The production API server",
|
||||
"variables": {
|
||||
"username": {
|
||||
"default": "demo",
|
||||
"description": "this value is assigned by the service"
|
||||
"provider, in this example `gigantic-server.com`",
|
||||
},
|
||||
"port": {"enum": ["8443", "443"], "default": "8443"},
|
||||
"basePath": {"default": "v2"},
|
||||
},
|
||||
},
|
||||
]
|
||||
|
||||
|
||||
class Server(BaseModel):
|
||||
"""An object representing a Server."""
|
||||
|
||||
url: str
|
||||
"""
|
||||
**REQUIRED**. A URL to the target host.
|
||||
|
||||
This URL supports Server Variables and MAY be relative,
|
||||
to indicate that the host location is relative to the location where the OpenAPI
|
||||
document is being served.
|
||||
Variable substitutions will be made when a variable is named in `{`brackets`}`.
|
||||
"""
|
||||
|
||||
description: Optional[str] = None
|
||||
"""
|
||||
An optional string describing the host designated by the URL.
|
||||
[CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text
|
||||
representation.
|
||||
"""
|
||||
|
||||
variables: Optional[Dict[str, ServerVariable]] = None
|
||||
"""
|
||||
A map between a variable name and its value.
|
||||
|
||||
The value is used for substitution in the server's URL template.
|
||||
"""
|
||||
|
||||
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