sysmocom
/
asterisk
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

rest-api-templates: Wikify error code response reasons 

Error response code descriptions may contain wiki markup that need to be
escaped. Without this patch, Confluence will reject the document being sent
and the responsible script will raise an exception.

Change-Id: I21fcb66fee7f6332381f2b99b1b0195dff215ee5
This commit is contained in:
Matt Jordan 2015-10-20 22:24:36 -05:00
parent b19860c03a
commit b425850f8b
2 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -67,7 +67,7 @@ h3. Header parameters
h3. Error Responses
{{#error_responses}}
* {{code}} - {{{reason}}}
* {{code}} - {{{wiki_reason}}}
{{/error_responses}}
{{/has_error_responses}}
{{/operations}}

2
rest-api-templates/asterisk_processor.py
View File

@ -199,6 +199,8 @@ class AsteriskProcessor(SwaggerPostProcessor):
raise SwaggerError("Summary should end with .", context)
operation.wiki_summary = wikify(operation.summary or "")
operation.wiki_notes = wikify(operation.notes or "")
for error_response in operation.error_responses:
error_response.wiki_reason = wikify(error_response.reason or "")
operation.parse_body = (operation.body_parameter or operation.has_query_parameters) and True
def process_parameter(self, parameter, context):