diff options
| author | Matt Jordan <mjordan@digium.com> | 2015-10-20 22:24:36 -0500 |
|---|---|---|
| committer | Matt Jordan <mjordan@digium.com> | 2015-10-20 22:24:36 -0500 |
| commit | 9fd2adc20430221dadd58c60d57655b95da168c6 (patch) | |
| tree | 87a69e1bea4d33f387ea8c4239bf761ab27ffde8 | |
| parent | 7c560a9a31ce93ae35ac80ca7f098929fbc5c6d5 (diff) | |
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
| -rw-r--r-- | rest-api-templates/api.wiki.mustache | 2 | ||||
| -rw-r--r-- | rest-api-templates/asterisk_processor.py | 2 |
2 files changed, 3 insertions, 1 deletions
diff --git a/rest-api-templates/api.wiki.mustache b/rest-api-templates/api.wiki.mustache index 73aa2448a..0a54a64a7 100644 --- a/rest-api-templates/api.wiki.mustache +++ b/rest-api-templates/api.wiki.mustache @@ -67,7 +67,7 @@ h3. Header parameters h3. Error Responses {{#error_responses}} -* {{code}} - {{{reason}}} +* {{code}} - {{{wiki_reason}}} {{/error_responses}} {{/has_error_responses}} {{/operations}} diff --git a/rest-api-templates/asterisk_processor.py b/rest-api-templates/asterisk_processor.py index ab8a8afd2..68a679994 100644 --- a/rest-api-templates/asterisk_processor.py +++ b/rest-api-templates/asterisk_processor.py @@ -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): |