summaryrefslogtreecommitdiff
path: root/rest-api-templates/asterisk_processor.py
diff options
context:
space:
mode:
authorMatthew Jordan <mjordan@digium.com>2015-01-27 17:21:03 +0000
committerMatthew Jordan <mjordan@digium.com>2015-01-27 17:21:03 +0000
commitfb8a2e039978b264737aa7a4ed08f9af4c329f47 (patch)
treefe2b256c707be4347f78c384468ffbf1aacba8dd /rest-api-templates/asterisk_processor.py
parentaa8fd7d1b9dcbcc207cbcc333df850b3e8e0be54 (diff)
ARI: Improve wiki documentation
This patch improves the documentation of ARI on the wiki. Specifically, it addresses the following: * Allowed values and allowed ranges weren't documented. This was particularly frustrating, as Asterisk would reject query parameters with disallowed values - but we didn't tell anyone what the allowed values were. * The /play/id operation on /channels and /bridges failed to document all of the added media resource types. * Documentation for creating a channel into a Stasis application failed to note when it occurred, and that creating a channel into Stasis conflicts with creating a channel into the dialplan. * Some other minor tweaks in the mustache templates, including italicizing the parameter type, putting the default value on its own sub-bullet, and some other nicities. Review: https://reviewboard.asterisk.org/r/4351 ........ Merged revisions 431145 from http://svn.asterisk.org/svn/asterisk/branches/13 git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@431148 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'rest-api-templates/asterisk_processor.py')
-rw-r--r--rest-api-templates/asterisk_processor.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/rest-api-templates/asterisk_processor.py b/rest-api-templates/asterisk_processor.py
index ef0f1673a..ab8a8afd2 100644
--- a/rest-api-templates/asterisk_processor.py
+++ b/rest-api-templates/asterisk_processor.py
@@ -223,6 +223,10 @@ class AsteriskProcessor(SwaggerPostProcessor):
else:
parameter.c_space = ' '
parameter.wiki_description = wikify(parameter.description)
+ if parameter.allowable_values:
+ parameter.wiki_allowable_values = parameter.allowable_values.to_wiki()
+ else:
+ parameter.wiki_allowable_values = None
def process_model(self, model, context):
model.description_dox = model.description.replace('\n', '\n * ')