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

Don't sort the HTTP APIs

Browse source 
We can order them manually in the YAML, so why would we want a completely
different order in the spec?
This commit is contained in:
Richard van der Hoff 2016-05-06 11:01:03 +01:00
parent 5cc9066159
commit 695a533e45
1 changed files with 6 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

15
templating/matrix_templates/sections.py
View file

@ -37,7 +37,7 @@ class MatrixSections(Sections):
))
return "\n\n".join(sections)
def _render_http_api_group(self, group, sortFnOrPathList=None):
def _render_http_api_group(self, group, sortPathList=None):
template = self.env.get_template("http-api.tmpl")
http_api = self.units.get("swagger_apis")[group]["__meta"]
subtitle_title_char = self.units.get("spec_targets")[
@ -45,11 +45,10 @@ class MatrixSections(Sections):
]["subtitle"]
sections = []
endpoints = []
if sortFnOrPathList:
if isinstance(sortFnOrPathList, list):
if sortPathList:
# list of substrings to sort by
sorted_endpoints = []
for path_substr in sortFnOrPathList:
for path_substr in sortPathList:
for e in http_api["endpoints"]:
if path_substr in e["path"]:
sorted_endpoints.append(e) # could have multiple
@ -57,13 +56,10 @@ class MatrixSections(Sections):
rest = [
e for e in http_api["endpoints"] if e not in sorted_endpoints
]
endpoints = sorted_endpoints + sorted(rest, key=lambda k: k["path"])
else:
# guess it's a func, call it.
endpoints = sortFnOrPathList(http_api["endpoints"])
endpoints = sorted_endpoints + rest
else:
# sort alphabetically based on path
endpoints = sorted(http_api["endpoints"], key=lambda k: k["path"])
endpoints = http_api["endpoints"]
for endpoint in endpoints:
sections.append(template.render(
@ -180,4 +176,3 @@ class MatrixSections(Sections):
template = self.env.get_template("apis.tmpl")
apis = self.units.get("apis")
return template.render(apis=apis)