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

Add more logging and make logging context clearer

Browse source 
This is now actually useful if you want to debug why your swagger YAML
isn't producing a table you think it should be.
This commit is contained in:
Kegan Dougal 2015-09-23 15:36:13 +01:00
parent f1adad5fb3
commit 6afdfc0771
3 changed files with 34 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

28
templating/matrix_templates/units.py
View file

@ -1,4 +1,12 @@
"""Contains all the units for the spec."""
"""
Contains all the units for the spec.
This file loads swagger and JSON schema files and parses out the useful bits
and returns them as Units for use in Batesian.
For the actual conversion of data -> RST (including templates), see the sections
file instead.
"""
from batesian.units import Units
import inspect
import json
@ -134,7 +142,7 @@ class MatrixUnits(Units):
"good_response": ""
}
}
self.log(".o.O.o. Endpoint: %s %s" % (method, path))
self.log(" ------- Endpoint: %s %s ------- " % (method, path))
for param in single_api.get("parameters", []):
# description
desc = param.get("description", "")
@ -183,6 +191,9 @@ class MatrixUnits(Units):
"desc": json_body[key]["description"]
})
# endfor[param]
for row in endpoint["req_params"]:
self.log("Request parameter: %s" % row)
# group params by location to ease templating
endpoint["req_param_by_loc"] = {
# path: [...], query: [...], body: [...]
@ -240,6 +251,7 @@ class MatrixUnits(Units):
# add response params if this API has any.
if good_response:
self.log("Found a 200 response for this API")
res_type = Units.prop(good_response, "schema/type")
if res_type and res_type not in ["object", "array"]:
# response is a raw string or something like that
@ -278,6 +290,16 @@ class MatrixUnits(Units):
}]
})
for response_table in endpoint["res_tables"]:
self.log("Response: %s" % response_table["title"])
for r in response_table["rows"]:
self.log("Row: %s" % r)
if len(endpoint["res_tables"]) == 0:
self.log(
"This API appears to have no response table. Are you " +
"sure this API returns no parameters?"
)
endpoints.append(endpoint)
aliases = single_api.get("x-alias", None)
@ -475,7 +497,7 @@ class MatrixUnits(Units):
if re.match("^v[0-9\.]+$", word):
version = word[1:] # strip the 'v'
self.log("Version: %s Title part: %s Changelog lines: %s" % (
self.log("Version: %s Title part: %s Changelog line count: %s" % (
version, title_part, len(changelog_lines)
))
if not version or len(changelog_lines) == 0: