{{ message }}
Repository navigation
Expand file tree
/
Copy pathdecode.py
More file actions
252 lines (212 loc) · 8.7 KB
/
Copy pathdecode.py
File metadata and controls
252 lines (212 loc) · 8.7 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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
from coreapi import Document, Link, Field
from coreapi.compat import string_types, urlparse
from coreapi.exceptions import ParseError
import coreschema
def _parse_document(data, base_url=None):
schema_url = base_url
base_url = _get_document_base_url(data, base_url)
info = _get_dict(data, 'info')
title = _get_string(info, 'title')
description = _get_string(info, 'description')
consumes = get_strings(_get_list(data, 'consumes'))
paths = _get_dict(data, 'paths')
content = {}
for path in paths.keys():
url = base_url + path.lstrip('/')
spec = _get_dict(paths, path)
default_parameters = get_dicts(_get_list(spec, 'parameters'))
for action in spec.keys():
action = action.lower()
if action not in ('get', 'put', 'post', 'delete', 'options', 'head', 'patch'):
continue
operation = _get_dict(spec, action)
# Determine any fields on the link.
has_body = False
has_form = False
fields = []
parameters = get_dicts(_get_list(operation, 'parameters', default_parameters), dereference_using=data)
for parameter in parameters:
name = _get_string(parameter, 'name')
location = _get_string(parameter, 'in')
required = _get_bool(parameter, 'required', default=(location == 'path'))
if location == 'body':
has_body = True
schema = _get_dict(parameter, 'schema', dereference_using=data)
expanded = _expand_schema(schema)
if expanded is not None:
# TODO: field schemas.
expanded_fields = [
Field(
name=field_name,
location='form',
required=is_required,
schema=coreschema.String(description=field_description)
)
for field_name, is_required, field_description in expanded
if not any([field.name == field_name for field in fields])
]
fields += expanded_fields
else:
# TODO: field schemas.
field_description = _get_string(parameter, 'description')
field = Field(
name=name,
location='body',
required=required,
schema=coreschema.String(description=field_description)
)
fields.append(field)
else:
if location == 'formData':
has_form = True
location = 'form'
field_description = _get_string(parameter, 'description')
# TODO: field schemas.
field = Field(
name=name,
location=location,
required=required,
schema=coreschema.String(description=field_description)
)
fields.append(field)
link_consumes = get_strings(_get_list(operation, 'consumes', consumes))
encoding = ''
if has_body:
encoding = _select_encoding(link_consumes)
elif has_form:
encoding = _select_encoding(link_consumes, form=True)
link_title = _get_string(operation, 'summary')
link_description = _get_string(operation, 'description')
link = Link(url=url, action=action, encoding=encoding, fields=fields, title=link_title, description=link_description)
# Add the link to the document content.
tags = get_strings(_get_list(operation, 'tags'))
operation_id = _get_string(operation, 'operationId')
if tags:
tag = tags[0]
prefix = tag + '_'
if operation_id.startswith(prefix):
operation_id = operation_id[len(prefix):]
if tag not in content:
content[tag] = {}
content[tag][operation_id] = link
else:
content[operation_id] = link
return Document(
url=schema_url,
title=title,
description=description,
content=content,
media_type='application/openapi+json'
)
def _get_document_base_url(data, base_url=None):
"""
Get the base url to use when constructing absolute paths from the
relative ones provided in the schema defination.
"""
prefered_schemes = ['https', 'http']
if base_url:
url_components = urlparse.urlparse(base_url)
default_host = url_components.netloc
default_scheme = url_components.scheme
else:
default_host = ''
default_scheme = None
host = _get_string(data, 'host', default=default_host)
path = _get_string(data, 'basePath', default='/')
path = '/' + path.lstrip('/')
path = path.rstrip('/') + '/'
if not host:
# No host is provided, and we do not have an initial URL.
return path
schemes = _get_list(data, 'schemes')
if not schemes:
# No schemes provided, use the initial URL, or a fallback.
scheme = default_scheme or prefered_schemes[0]
elif default_scheme in schemes:
# Schemes provided, the initial URL matches one of them.
scheme = default_scheme
else:
# Schemes provided, the initial URL does not match, pick a fallback.
for scheme in prefered_schemes:
if scheme in schemes:
break
else:
raise ParseError('Unsupported transport schemes "%s"' % schemes)
return '%s://%s%s' % (scheme, host, path)
def _select_encoding(consumes, form=False):
"""
Given an OpenAPI 'consumes' list, return a single 'encoding' for CoreAPI.
"""
if form:
preference = [
'multipart/form-data',
'application/x-www-form-urlencoded',
'application/json'
]
else:
preference = [
'application/json',
'multipart/form-data',
'application/x-www-form-urlencoded',
'application/octet-stream'
]
if not consumes:
return preference[0]
for media_type in preference:
if media_type in consumes:
return media_type
return consumes[0]
def _expand_schema(schema):
"""
When an OpenAPI parameter uses `in="body"`, and the schema type is "object",
then we expand out the parameters of the object into individual fields.
"""
schema_type = schema.get('type')
schema_properties = _get_dict(schema, 'properties')
schema_required = _get_list(schema, 'required')
if ((schema_type == ['object']) or (schema_type == 'object')) and schema_properties:
return [
(key, key in schema_required, schema_properties[key].get('description'))
for key in schema_properties.keys()
]
return None
# Helper functions to get an expected type from a dictionary.
def dereference(lookup_string, struct):
"""
Dereference a JSON pointer.
http://tools.ietf.org/html/rfc6901
"""
keys = lookup_string.strip('#/').split('/')
node = struct
for key in keys:
node = _get_dict(node, key)
return node
def is_json_pointer(value):
return isinstance(value, dict) and ('$ref' in value) and (len(value) == 1)
def _get_string(item, key, default=''):
value = item.get(key)
return value if isinstance(value, string_types) else default
def _get_dict(item, key, default={}, dereference_using=None):
value = item.get(key)
if isinstance(value, dict):
if dereference_using and is_json_pointer(value):
return dereference(value['$ref'], dereference_using)
return value
return default.copy()
def _get_list(item, key, default=[]):
value = item.get(key)
return value if isinstance(value, list) else list(default)
def _get_bool(item, key, default=False):
value = item.get(key)
return value if isinstance(value, bool) else default
# Helper functions to get an expected type from a list.
def get_dicts(item, dereference_using=None):
ret = [value for value in item if isinstance(value, dict)]
if dereference_using:
return [
dereference(value['$ref'], dereference_using) if is_json_pointer(value) else value
for value in ret
]
return ret
def get_strings(item):
return [value for value in item if isinstance(value, string_types)]
You can’t perform that action at this time.