diff options
| author | Sam Galarneau <sgalarneau@digium.com> | 2014-07-03 15:35:22 +0000 |
|---|---|---|
| committer | Sam Galarneau <sgalarneau@digium.com> | 2014-07-03 15:35:22 +0000 |
| commit | 5db3f38d5a8d49e4d07e6342b4557092496d28de (patch) | |
| tree | 531d9ab1906396fbe8b55eb750d3e6c0c530bbf1 /rest-api-templates | |
| parent | da469fd9f67bcb3424102e1503894387071d84aa (diff) | |
api.wiki.mustache: Update wiki template to support body parameters
This patch updates the api.wiki.mustache template and the swagger_model python
script to understand if an operation has a body parameter. If an operation
does have a body parameter, it will now be displayed in the corresponding
wiki entry.
........
Merged revisions 407389 from http://svn.asterisk.org/svn/asterisk/branches/12
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@417877 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'rest-api-templates')
| -rw-r--r-- | rest-api-templates/api.wiki.mustache | 10 | ||||
| -rw-r--r-- | rest-api-templates/swagger_model.py | 1 |
2 files changed, 11 insertions, 0 deletions
diff --git a/rest-api-templates/api.wiki.mustache b/rest-api-templates/api.wiki.mustache index 322bb58df..de6de2dcc 100644 --- a/rest-api-templates/api.wiki.mustache +++ b/rest-api-templates/api.wiki.mustache @@ -31,6 +31,16 @@ h3. Query parameters {{/allow_multiple}} {{/query_parameters}} {{/has_query_parameters}} +{{#has_body_parameter}} + +h3. Body parameter +{{#body_parameter}} +* {{name}}: {{data_type}}{{#default_value}} = {{default_value}}{{/default_value}} -{{#required}} *(required)*{{/required}} {{{wiki_description}}} +{{#allow_multiple}} +** Allows comma separated values. +{{/allow_multiple}} +{{/body_parameter}} +{{/has_body_parameter}} {{#has_header_parameters}} h3. Header parameters diff --git a/rest-api-templates/swagger_model.py b/rest-api-templates/swagger_model.py index 01659d145..9c65219e5 100644 --- a/rest-api-templates/swagger_model.py +++ b/rest-api-templates/swagger_model.py @@ -402,6 +402,7 @@ class Operation(Stringify): if len(self.body_parameter) > 1: raise SwaggerError("Cannot have more than one body param", context) self.body_parameter = self.body_parameter and self.body_parameter[0] + self.has_body_parameter = self.body_parameter and True self.summary = op_json.get('summary') self.notes = op_json.get('notes') |