Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-18 17:34:09 +01:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

More example formatting improvements

Browse source 
Generate more realistic example integers, and do some sanity checks on other
examples.
This commit is contained in:
Richard van der Hoff 2016-10-14 12:20:00 +01:00
parent b12b38d680
commit 57611ec523
1 changed files with 31 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
templating/matrix_templates/units.py
View file

@ -372,16 +372,31 @@ def get_example_for_schema(schema):
if 'example' in schema: if 'example' in schema:
example = schema['example'] example = schema['example']
return example return example
if 'properties' in schema:
proptype = schema['type']
if proptype == 'object':
if 'properties' not in schema:
raise Exception('"object" property has neither properties nor example')
res = OrderedDict() res = OrderedDict()
for prop_name, prop in schema['properties'].iteritems(): for prop_name, prop in schema['properties'].iteritems():
logger.debug("Parsing property %r" % prop_name) logger.debug("Parsing property %r" % prop_name)
prop_example = get_example_for_schema(prop) prop_example = get_example_for_schema(prop)
res[prop_name] = prop_example res[prop_name] = prop_example
return res return res
if 'items' in schema:
if proptype == 'array':
if 'items' not in schema:
raise Exception('"array" property has neither items nor example')
return [get_example_for_schema(schema['items'])] return [get_example_for_schema(schema['items'])]
return schema.get('type', '??')
if proptype == 'integer':
return 0
if proptype == 'string':
return proptype
raise Exception("Don't know to make an example %s" % proptype)
def get_example_for_param(param): def get_example_for_param(param):
"""Returns a stringified example for a parameter""" """Returns a stringified example for a parameter"""
@ -418,9 +433,14 @@ def get_example_for_response(response):
if exampleobj is None: if exampleobj is None:
schema = response.get('schema') schema = response.get('schema')
if schema: if schema:
if schema['type'] == 'file':
# no example for 'file' responses
return None
exampleobj = get_example_for_schema(schema) exampleobj = get_example_for_schema(schema)
if exampleobj is None: if exampleobj is None:
return None return None
return json.dumps(exampleobj, indent=2) return json.dumps(exampleobj, indent=2)
class MatrixUnits(Units): class MatrixUnits(Units):
@ -512,29 +532,31 @@ class MatrixUnits(Units):
qps = [] qps = []
body = "" body = ""
for param in single_api.get("parameters", []): for param in single_api.get("parameters", []):
paramname = param.get("name")
try: try:
example = get_example_for_param(param) example = get_example_for_param(param)
if not example: if not example:
logger.warn( logger.warn(
"The parameter %s is missing an example." % "The parameter %s is missing an example.",
param["name"]) paramname
)
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}" % paramname, urllib.quote(example)
) )
elif param["in"] == "body": elif param["in"] == "body":
body = example body = example
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((paramname, value))
else: else:
qps.append((param["name"], example)) qps.append((paramname, example))
except Exception, e: except Exception, e:
raise Exception("Error handling parameter %s" % param["name"], raise Exception("Error handling parameter %s" % paramname,
e) e)
query_string = "" if len(qps) == 0 else "?"+urllib.urlencode(qps) query_string = "" if len(qps) == 0 else "?"+urllib.urlencode(qps)