wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Attempt to parse examples as json

Browse source 
... because some of them are, and we don't want to double-escape them.
This commit is contained in:
Richard van der Hoff 2016-05-06 16:05:05 +01:00
parent 6b23598a26
commit 45199d0edc
1 changed files with 31 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

52
templating/matrix_templates/units.py
View file

@ -276,7 +276,14 @@ def get_tables_for_schema(schema, mark_required=True):
def get_example_for_schema(schema): def get_example_for_schema(schema):
"""Returns a python object representing a suitable example for this object""" """Returns a python object representing a suitable example for this object"""
if 'example' in schema: if 'example' in schema:
return schema['example'] example = schema['example']
if isinstance(example, basestring):
try:
example = json.loads(example)
except ValueError:
# not json, just use the string
pass
return example
if 'properties' in schema: if 'properties' in schema:
res = {} res = {}
for prop_name, prop in schema['properties'].iteritems(): for prop_name, prop in schema['properties'].iteritems():
@ -293,8 +300,7 @@ def get_example_for_param(param):
return param['x-example'] return param['x-example']
if 'schema' not in param: if 'schema' not in param:
return None return None
return json.dumps(get_example_for_schema(param['schema']), return get_example_for_schema(param['schema'])
indent=2)
class MatrixUnits(Units): class MatrixUnits(Units):
def _load_swagger_meta(self, api, group_name): def _load_swagger_meta(self, api, group_name):
@ -366,26 +372,30 @@ class MatrixUnits(Units):
qps = [] qps = []
body = "" body = ""
for param in single_api.get("parameters", []): for param in single_api.get("parameters", []):
example = get_example_for_param(param) try:
example = get_example_for_param(param)
if not example: if not example:
self.log( self.log(
"The parameter %s is missing an example." % "The parameter %s is missing an example." %
param["name"]) param["name"])
continue continue
if param["in"] == "path": if param["in"] == "path":
path_template = path_template.replace( path_template = path_template.replace(
"{%s}" % param["name"], urllib.quote(example) "{%s}" % param["name"], urllib.quote(example)
) )
elif param["in"] == "body": elif param["in"] == "body":
body = example body = json.dumps(example, indent=2)
elif param["in"] == "query": elif param["in"] == "query":
if type(example) == list: if type(example) == list:
for value in example: for value in example:
qps.append((param["name"], value)) qps.append((param["name"], value))
else: else:
qps.append((param["name"], example)) qps.append((param["name"], example))
except Exception, e:
raise Exception("Error handling parameter %s" % param["name"],
e)
query_string = "" if len(qps) == 0 else "?"+urllib.urlencode(qps) query_string = "" if len(qps) == 0 else "?"+urllib.urlencode(qps)
if body: if body: