48 lines
1.4 KiB
Plaintext
48 lines
1.4 KiB
Plaintext
{{#api_declaration}}
|
|
h1. {{name_title}}
|
|
|
|
|| Method || Path || Return Model || Summary ||
|
|
{{#apis}}
|
|
{{#operations}}
|
|
| {{http_method}} | [{{wiki_path}}|#{{nickname}}] | {{#response_class}}{{#is_primitive}}{{name}}{{/is_primitive}}{{^is_primitive}}[{{wiki_name}}|{{wiki_prefix}} REST Data Models#{{singular_name}}]{{/is_primitive}}{{/response_class}} | {{summary}} |
|
|
{{/operations}}
|
|
{{/apis}}
|
|
{{#apis}}
|
|
{{#operations}}
|
|
|
|
{anchor:{{nickname}}}
|
|
h2. {{http_method}} {{wiki_path}}
|
|
|
|
{{{summary}}}{{#notes}} {{{notes}}}{{/notes}}
|
|
{{#has_path_parameters}}
|
|
|
|
h3. Path parameters
|
|
{{#path_parameters}}
|
|
* {{name}}: {{data_type}}{{#default_value}} = {{default_value}}{{/default_value}} - {{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}}
|
|
{{/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}}
|
|
{{/header_parameters}}
|
|
{{/has_header_parameters}}
|
|
{{#has_error_responses}}
|
|
|
|
h3. Error Responses
|
|
{{#error_responses}}
|
|
* {{code}} - {{{reason}}}
|
|
{{/error_responses}}
|
|
{{/has_error_responses}}
|
|
{{/operations}}
|
|
{{/apis}}
|
|
{{/api_declaration}}
|