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

Add HTTP API wip template.

Browse source
This commit is contained in:
Kegan Dougal 2015-06-01 12:03:42 +01:00
parent 5795e1ceda
commit c75fd6bcae
3 changed files with 35 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

14
templating/matrix_templates/units.py
View file

@ -104,8 +104,8 @@ class MatrixUnits(Units):
for method in api["paths"][path]:
single_api = api["paths"][path][method]
endpoint = {
"title": single_api.get("summary"),
"desc": single_api.get("description"),
"title": single_api.get("summary", ""),
"desc": single_api.get("description", ""),
"method": method.upper(),
"path": path,
"requires_auth": "security" in single_api,
@ -118,7 +118,7 @@ class MatrixUnits(Units):
self.log(".o.O.o. Endpoint: %s %s" % (method, path))
for param in single_api.get("parameters", []):
# description
desc = param.get("description")
desc = param.get("description", "")
if param.get("required"):
desc = "**Required.** " + desc
@ -133,8 +133,8 @@ class MatrixUnits(Units):
if val_type:
endpoint["req_params"].append({
"name": param["name"],
"type": param["in"],
"val_type": val_type,
"loc": param["in"],
"type": val_type,
"desc": desc
})
continue
@ -159,8 +159,8 @@ class MatrixUnits(Units):
for key in json_body:
endpoint["req_params"].append({
"name": key,
"type": "JSON",
"val_type": json_body[key]["type"],
"loc": "JSON",
"type": json_body[key]["type"],
"desc": json_body[key]["description"]
})