kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-21 20:56:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

api.wiki.mustache: Update wiki template to support body parameters

Browse Source 
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.


git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/12@407389 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Matthew Jordan
2014-02-05 00:08:50 +00:00
parent 5b83882bee
commit e970ea2dc4
2 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
rest-api-templates/api.wiki.mustache
View File

@@ -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

1
rest-api-templates/swagger_model.py
View File

@@ -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')