diff options
Diffstat (limited to 'rest-api-templates')
-rw-r--r-- | rest-api-templates/api.wiki.mustache | 8 | ||||
-rw-r--r-- | rest-api-templates/asterisk_processor.py | 3 | ||||
-rw-r--r-- | rest-api-templates/models.wiki.mustache | 8 |
3 files changed, 11 insertions, 8 deletions
diff --git a/rest-api-templates/api.wiki.mustache b/rest-api-templates/api.wiki.mustache index a19e496e1..ba3a3d18c 100644 --- a/rest-api-templates/api.wiki.mustache +++ b/rest-api-templates/api.wiki.mustache @@ -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}} diff --git a/rest-api-templates/asterisk_processor.py b/rest-api-templates/asterisk_processor.py index 65013d338..2ea552932 100644 --- a/rest-api-templates/asterisk_processor.py +++ b/rest-api-templates/asterisk_processor.py @@ -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 diff --git a/rest-api-templates/models.wiki.mustache b/rest-api-templates/models.wiki.mustache index e3d3eb95c..b2e742afc 100644 --- a/rest-api-templates/models.wiki.mustache +++ b/rest-api-templates/models.wiki.mustache @@ -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}} |