forked from openapi-generators/openapi-python-client
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathencoding.py
More file actions
75 lines (60 loc) · 2.87 KB
/
encoding.py
File metadata and controls
75 lines (60 loc) · 2.87 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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
from typing import Dict, Optional
from pydantic import BaseModel
from .reference import Reference
class Encoding(BaseModel):
"""A single encoding definition applied to a single schema property."""
contentType: Optional[str] = None
"""
The Content-Type for encoding a specific property.
Default value depends on the property type:
- for `string` with `format` being `binary` – `application/octet-stream`;
- for other primitive types – `text/plain`;
- for `object` - `application/json`;
- for `array` – the default is defined based on the inner type.
The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`),
or a comma-separated list of the two types.
"""
headers: Optional[Dict[str, Reference]] = None
"""
A map allowing additional information to be provided as headers, for example `Content-Disposition`.
`Content-Type` is described separately and SHALL be ignored in this section.
This property SHALL be ignored if the request body media type is not a `multipart`.
"""
style: Optional[str] = None
"""
Describes how a specific property value will be serialized depending on its type.
See [Parameter Object](#parameterObject) for details on the [`style`](#parameterStyle) property.
The behavior follows the same values as `query` parameters, including default values.
This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`.
"""
explode: bool = False
"""
When this is true, property values of type `array` or `object` generate separate parameters
for each value of the array, or key-value-pair of the map.
For other types of properties this property has no effect.
When [`style`](#encodingStyle) is `form`, the default value is `true`.
For all other styles, the default value is `false`.
This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`.
"""
allowReserved: bool = False
"""
Determines whether the parameter value SHOULD allow reserved characters,
as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2)
`:/?#[]@!$&'()*+,;=` to be included without percent-encoding.
The default value is `false`.
This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`.
"""
class Config:
schema_extra = {
"examples": [
{
"contentType": "image/png, image/jpeg",
"headers": {
"X-Rate-Limit-Limit": {
"description": "The number of allowed requests in the current period",
"schema": {"type": "integer"},
}
},
}
]
}