]> git.ipfire.org Git - thirdparty/asterisk.git/commitdiff
Correct some ARI wiki rendering errors
authorDavid M. Lee <dlee@digium.com>
Thu, 10 Oct 2013 19:23:24 +0000 (19:23 +0000)
committerDavid M. Lee <dlee@digium.com>
Thu, 10 Oct 2013 19:23:24 +0000 (19:23 +0000)
git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/12@400842 65c4cc65-6c06-0410-ace0-fbb531ad65f3

rest-api-templates/api.wiki.mustache
rest-api-templates/asterisk_processor.py
rest-api-templates/models.wiki.mustache

index a19e496e1198310815364c87d211671ce4f620d8..ba3a3d18cfcdc92545ffd55895e4e916e065ccf2 100644 (file)
@@ -13,26 +13,26 @@ h1. {{name_title}}
 {anchor:{{nickname}}}
 h2. {{http_method}} {{wiki_path}}
 
-{{{summary}}}{{#wiki_notes}} {{{wiki_notes}}}{{/wiki_notes}}
+{{{wiki_summary}}}{{#wiki_notes}} {{{wiki_notes}}}{{/wiki_notes}}
 {{#has_path_parameters}}
 
 h3. Path parameters
 {{#path_parameters}}
-* {{name}}: {{data_type}}{{#default_value}} = {{default_value}}{{/default_value}} - {{description}}
+* {{name}}: {{data_type}}{{#default_value}} = {{default_value}}{{/default_value}} - {{{wiki_description}}}
 {{/path_parameters}}
 {{/has_path_parameters}}
 {{#has_query_parameters}}
 
 h3. Query parameters
 {{#query_parameters}}
-* {{name}}: {{data_type}}{{#default_value}} = {{default_value}}{{/default_value}} -{{#required}} *(required)*{{/required}} {{description}}
+* {{name}}: {{data_type}}{{#default_value}} = {{default_value}}{{/default_value}} -{{#required}} *(required)*{{/required}} {{{wiki_description}}}
 {{/query_parameters}}
 {{/has_query_parameters}}
 {{#has_header_parameters}}
 
 h3. Header parameters
 {{#header_parameters}}
-* {{name}}: {{data_type}}{{#default_value}} = {{default_value}}{{/default_value}} -{{#required}} *(required)*{{/required}} {{description}}
+* {{name}}: {{data_type}}{{#default_value}} = {{default_value}}{{/default_value}} -{{#required}} *(required)*{{/required}} {{{wiki_description}}}
 {{/header_parameters}}
 {{/has_header_parameters}}
 {{#has_error_responses}}
index 65013d3384721219e31ac8a9c0995d39fd857b25..2ea552932718214fea5d6f63d7e05d17a6b74206 100644 (file)
@@ -187,6 +187,7 @@ class AsteriskProcessor(SwaggerPostProcessor):
         operation.c_http_method = 'AST_HTTP_' + operation.http_method
         if not operation.summary.endswith("."):
             raise SwaggerError("Summary should end with .", context)
+        operation.wiki_summary = wikify(operation.summary or "")
         operation.wiki_notes = wikify(operation.notes or "")
 
     def process_parameter(self, parameter, context):
@@ -202,10 +203,12 @@ class AsteriskProcessor(SwaggerPostProcessor):
             parameter.c_space = ''
         else:
             parameter.c_space = ' '
+        parameter.wiki_description = wikify(parameter.description)
 
     def process_model(self, model, context):
         model.description_dox = model.description.replace('\n', '\n * ')
         model.description_dox = re.sub(' *\n', '\n', model.description_dox)
+        model.wiki_description = wikify(model.description)
         model.c_id = snakify(model.id)
         return model
 
index e3d3eb95caf98333d2524a0897182de03394fd8e..b2e742afc4df3293b5cb234569e01192ff0909a3 100644 (file)
@@ -6,15 +6,15 @@
 h1. {{id}}
 {{#extends}}Base type: [{{extends}}|#{{extends}}]{{/extends}}
 {{#has_subtypes}}Subtypes:{{#subtypes}} [{{id}}|#{{id}}]{{/subtypes}}{{/has_subtypes}}
-{{#description}}
+{{#wiki_description}}
 
-{{{description}}}
-{{/description}}
+{{{wiki_description}}}
+{{/wiki_description}}
 {code:language=javascript|collapse=true}
 {{{model_json}}}
 {code}
 {{#properties}}
-* {{name}}: {{#type}}{{#is_primitive}}{{wiki_name}}{{/is_primitive}}{{^is_primitive}}[{{wiki_name}}|#{{singular_name}}]{{/is_primitive}}{{/type}}{{^required}} _(optional)_{{/required}}{{#description}} - {{{description}}}{{/description}}
+* {{name}}: {{#type}}{{#is_primitive}}{{wiki_name}}{{/is_primitive}}{{^is_primitive}}[{{wiki_name}}|#{{singular_name}}]{{/is_primitive}}{{/type}}{{^required}} _(optional)_{{/required}}{{#wiki_description}} - {{{wiki_description}}}{{/wiki_description}}
 {{/properties}}
 
 {{/models}}