From b425850f8b859a04c997d71eced223a445097c4e Mon Sep 17 00:00:00 2001 From: Matt Jordan Date: Tue, 20 Oct 2015 22:24:36 -0500 Subject: 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 --- rest-api-templates/api.wiki.mustache | 2 +- rest-api-templates/asterisk_processor.py | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) (limited to 'rest-api-templates') 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): -- cgit v1.2.3