forked from openapi-generators/openapi-python-client
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathexample.py
More file actions
45 lines (36 loc) · 1.41 KB
/
example.py
File metadata and controls
45 lines (36 loc) · 1.41 KB
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
from typing import Any, Optional
from pydantic import BaseModel
class Example(BaseModel):
summary: Optional[str] = None
"""
Short description for the example.
"""
description: Optional[str] = None
"""
Long description for the example.
[CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation.
"""
value: Optional[Any] = None
"""
Embedded literal example.
The `value` field and `externalValue` field are mutually exclusive.
To represent examples of media types that cannot naturally represented in JSON or YAML,
use a string value to contain the example, escaping where necessary.
"""
externalValue: Optional[str] = None
"""
A URL that points to the literal example.
This provides the capability to reference examples that cannot easily be included in JSON or YAML documents.
The `value` field and `externalValue` field are mutually exclusive.
"""
class Config:
schema_extra = {
"examples": [
{"summary": "A foo example", "value": {"foo": "bar"}},
{
"summary": "This is an example in XML",
"externalValue": "http://example.org/examples/address-example.xml",
},
{"summary": "This is a text example", "externalValue": "http://foo.bar/examples/address-example.txt"},
]
}