[Asterisk-code-review] ari: Add documentation that path parameters are case-sensitive (asterisk[13])
Anonymous Coward
asteriskteam at digium.com
Fri Aug 19 08:05:12 CDT 2016
Anonymous Coward #1000019 has submitted this change and it was merged.
Change subject: ari: Add documentation that path parameters are case-sensitive
......................................................................
ari: Add documentation that path parameters are case-sensitive
Added to api.wiki.mustache so that the generated object pages
have the notation in the table header as well as under each method
that has path parameters.
ASTERISK-25492 #close
Change-Id: I36c46c6dc0c9ac350470394a999a1b19ef3fcdaf
---
M rest-api-templates/api.wiki.mustache
1 file changed, 3 insertions(+), 1 deletion(-)
Approvals:
Mark Michelson: Looks good to me, approved
Anonymous Coward #1000019: Verified
Joshua Colp: Looks good to me, but someone else must approve
diff --git a/rest-api-templates/api.wiki.mustache b/rest-api-templates/api.wiki.mustache
index 0a54a64..ad12bb6 100644
--- a/rest-api-templates/api.wiki.mustache
+++ b/rest-api-templates/api.wiki.mustache
@@ -1,7 +1,8 @@
{{#api_declaration}}
h1. {{name_title}}
-|| Method || Path || Return Model || Summary ||
+|| Method || Path<br>h5. Parameters are case-sensitive || Return Model || Summary ||
+
{{#apis}}
{{#operations}}
| {{http_method}} | [{{wiki_path}}|#{{nickname}}] | {{#response_class}}{{#is_primitive}}{{name}}{{/is_primitive}}{{^is_primitive}}[{{wiki_name}}|{{wiki_prefix}} REST Data Models#{{singular_name}}]{{/is_primitive}}{{/response_class}} | {{summary}} |
@@ -17,6 +18,7 @@
{{#has_path_parameters}}
h3. Path parameters
+Parameters are case-sensitive.
{{#path_parameters}}
* {{name}}: _{{data_type}}_ - {{{wiki_description}}}
{{#default_value}}
--
To view, visit https://gerrit.asterisk.org/3570
To unsubscribe, visit https://gerrit.asterisk.org/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I36c46c6dc0c9ac350470394a999a1b19ef3fcdaf
Gerrit-PatchSet: 1
Gerrit-Project: asterisk
Gerrit-Branch: 13
Gerrit-Owner: George Joseph <gjoseph at digium.com>
Gerrit-Reviewer: Anonymous Coward #1000019
Gerrit-Reviewer: Joshua Colp <jcolp at digium.com>
Gerrit-Reviewer: Mark Michelson <mmichelson at digium.com>
More information about the asterisk-code-review
mailing list