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

Enable syntax highlighting for example http requests

Browse source
This commit is contained in:
Mark Haines 2015-10-26 17:25:33 +00:00
parent f3fd6e92fc
commit 71874870c8
3 changed files with 24 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

14
scripts/css/codehighlight.css
View file

@ -1,6 +1,16 @@
pre.code .comment, code .comment { color: green } pre.code .comment, code .comment { color: green }
pre.code .keyword, code .keyword { color: darkred; font-weight: bold } pre.code .keyword, code .keyword { color: darkred; font-weight: bold }
pre.code .name.builtin, code .name.builtin { color: darkred; font-weight: bold } pre.code .name.builtin, code .name.builtin { color: darkred; font-weight: bold }
pre.code .literal.number, code .literal.number { color: blue }
pre.code .name.tag, code .name.tag { color: darkgreen } pre.code .name.tag, code .name.tag { color: darkgreen }
pre.code .literal.string, code .literal.string { color: darkblue } pre.code .literal, code .literal { color: darkblue }
pre.code .literal.number, code .literal.number { color: blue }
/* HTTP Methods have class "name function" */
pre.code.http .name.function, code.http .name.function { color: black; font-weight: bold }
/* HTTP Paths have class "name namespace" */
pre.code.http .name.namespace, code.http .name.namespace { color: darkgreen }
/* HTTP "HTTP" strings have class "keyword reserved" */
pre.code.http .keyword.reserved, code.http .keyword.reserved { color: black; font-weight: bold }
/* HTTP Header names have class "name attribute" */
pre.code.http .name.attribute, code.http .name.attribute { color: black; font-weight: bold }

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

@ -47,7 +47,9 @@ Response format:
{% endfor %} {% endfor %}
{% endif -%} {% endif -%}
Example request:: Example request:
.. code:: http
{{endpoint.example.req | indent_block(2)}} {{endpoint.example.req | indent_block(2)}}

12
templating/matrix_templates/units.py
View file

@ -336,9 +336,15 @@ class MatrixUnits(Units):
elif param["in"] == "query": elif param["in"] == "query":
qps[param["name"]] = param["x-example"] qps[param["name"]] = param["x-example"]
query_string = "" if len(qps) == 0 else "?"+urllib.urlencode(qps) query_string = "" if len(qps) == 0 else "?"+urllib.urlencode(qps)
endpoint["example"]["req"] = "%s %s%s\n%s" % ( if body:
method.upper(), path_template, query_string, body endpoint["example"]["req"] = "%s %s%s HTTP/1.1\nContent-Type: application/json\n\n%s" % (
) method.upper(), path_template, query_string, body
)
else:
endpoint["example"]["req"] = "%s %s%s HTTP/1.1\n\n" % (
method.upper(), path_template, query_string
)
else: else:
self.log( self.log(
"The following parameters are missing examples :( \n %s" % "The following parameters are missing examples :( \n %s" %