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

Modify how descriptions are shown. Add profile API descriptions.

Browse source
This commit is contained in:
Kegan Dougal 2015-06-01 14:34:13 +01:00
parent 862f5a3a53
commit ba6ce16509
3 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
templating/matrix_templates/templates/http-api.tmpl
View file

@ -2,8 +2,10 @@
{{(5 + (endpoint.path | length) + (endpoint.method | length)) * title_kind}}
{{endpoint.desc | wrap(80)}}
{{":Rate-limited: Yes." if endpoint.rate_limited else "" }}
{{":Requires auth: Yes." if endpoint.requires_auth else "" }}
Request format:
================== ================= =========== ===============================

2
templating/matrix_templates/units.py
View file

@ -106,7 +106,7 @@ class MatrixUnits(Units):
single_api = api["paths"][path][method]
endpoint = {
"title": single_api.get("summary", ""),
"desc": single_api.get("description", ""),
"desc": single_api.get("description", single_api.get("summary", "")),
"method": method.upper(),
"path": path,
"requires_auth": "security" in single_api,