8000 Merge pull request #1 from zbyte64/coreschema-format · dd/python-openapi-codec@8a7a098 · GitHub
[go: up one dir, main page]
Skip to content

Commit 8a7a098

Browse files
author
dimka
authored
Merge pull request #1 from zbyte64/coreschema-format
Coreschema format
2 parents baa97e0 + 9e11a71 commit 8a7a098

File tree

3 files changed

+59
-3
lines changed

3 files changed

+59
-3
lines changed

‎openapi_codec/decode.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ def _parse_document(data, base_url=None):
4444
name=field_name,
4545
location='form',
4646
required=is_required,
47-
schema=coreschema.String(description=field_description)
47+
schema=coreschema.String(description=field_description, format=field_format)
4848
)
49-
for field_name, is_required, field_description in expanded
49+
for field_name, is_required, field_description, field_format in expanded
5050
if not any([field.name == field_name for field in fields])
5151
]
5252
fields += expanded_fields
@@ -188,7 +188,7 @@ def _expand_schema(schema):
188188
schema_required = _get_list(schema, 'required')
189189
if ((schema_type == ['object']) or (schema_type == 'object')) and schema_properties:
190190
return [
191-
(key, key in schema_required, schema_properties[key].get('description'))
191+
(key, key in schema_required, schema_properties[key].get('description'), schema_properties[key].get('format'))
192192
for key in schema_properties.keys()
193193
]
194194
return None

‎openapi_codec/encode.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,10 @@ def _get_field_type(field):
128128
}.get(field.schema.__class__, 'string')
129129

130130

131+
def _get_field_format(field):
132+
return field.schema and getattr(field.schema, 'format', None)
133+
134+
131135
def _get_parameters(link, encoding):
132136
"""
133137
Generates Swagger Parameter Item object.
@@ -140,6 +144,7 @@ def _get_parameters(link, encoding):
140144
location = get_location(link, field)
141145
field_description = _get_field_description(field)
142146
field_type = _get_field_type(field)
147+
field_format = _get_field_format(field)
143148
if location == 'form':
144149
if encoding in ('multipart/form-data', 'application/x-www-form-urlencoded'):
145150
# 'formData' in swagger MUST be one of these media types.
@@ -152,6 +157,8 @@ def _get_parameters(link, encoding):
152157
}
153158
if field_type == 'array':
154159
parameter['items'] = {'type': 'string'}
160+
if field_format:
161+
parameter['format'] = field_format
155162
parameters.append(parameter)
156163
else:
157164
# Expand coreapi fields with location='form' into a single swagger
@@ -179,6 +186,8 @@ def _get_parameters(link, encoding):
179186
'description': field_description,
180187
'schema': schema
181188
}
189+
if field_format:
190+
parameter['format'] = field_format
182191
parameters.append(parameter)
183192
else:
184193
parameter = {
@@ -190,6 +199,8 @@ def _get_parameters(link, encoding):
190199
}
191200
if field_type == 'array':
192201
parameter['items'] = {'type': 'string'}
202+
if field_format:
203+
parameter['format'] = field_format
193204
parameters.append(parameter)
194205

195206
if properties:

‎tests/test_encode.py

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,3 +106,48 @@ def test_expected_fields(self):
106106
'type': 'string' # Everything is a string for now.
107107
}
108108
self.assertEquals(self.swagger[0], expected)
109+
110+
111+
class TestFormat(TestCase):
112+
def setUp(self):
113+
self.field = coreapi.Field(
114+
name='published_before',
115+
required=True,
116+
location='query',
117+
schema=coreschema.String(description='Filter by published date.', format='date')
118+
)
119+
self.swagger = _get_parameters(coreapi.Link(fields=[self.field]), encoding='')
120+
121+
def test_expected_fields(self):
122+
self.assertEquals(len(self.swagger), 1)
123+
expected = {
124+
'name': self.field.name,
125+
'required': self.field.required,
126+
'in': 'query',
127+
'description': self.field.schema.description,
128+
'type': 'string',
129+
'format': 'date'
130+
}
131+
self.assertEquals(self.swagger[0], expected)
132+
133+
134+
class TestInteger 6D40 Field(TestCase):
135+
def setUp(self):
136+
self.field = coreapi.Field(
137+
name='page',
138+
required=True,
139+
location='query',
140+
schema=coreschema.Integer(description='A page number.')
141+
)
142+
self.swagger = _get_parameters(coreapi.Link(fields=[self.field]), encoding='')
143+
144+
def test_expected_fields(self):
145+
self.assertEquals(len(self.swagger), 1)
146+
expected = {
147+
'name': self.field.name,
148+
'required': self.field.required,
149+
'in': 'query',
150+
'description': self.field.schema.description,
151+
'type': 'integer'
152+
}
153+
self.assertEquals(self.swagger[0], expected)

0 commit comments

Comments
 (0)
0