pjproject_bundled: check whether UPDATE is supported on outgoing calls
[asterisk/asterisk.git] / rest-api-templates / api.wiki.mustache
1 {{#api_declaration}}
2 h1. {{name_title}}
3
4 || Method || Path<br>h5. Parameters are case-sensitive || Return Model || Summary ||
5
6 {{#apis}}
7 {{#operations}}
8 | {{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}}} |
9 {{/operations}}
10 {{/apis}}
11 {{#apis}}
12 {{#operations}}
13
14 {anchor:{{nickname}}}
15 h2. {{nickname}}: {{http_method}} {{wiki_path}}
16
17 {{{wiki_summary}}}{{#wiki_notes}} {{{wiki_notes}}}{{/wiki_notes}}
18 {{#has_path_parameters}}
19
20 h3. Path parameters
21 Parameters are case-sensitive.
22 {{#path_parameters}}
23 * {{name}}: _{{data_type}}_ - {{{wiki_description}}}
24 {{#default_value}}
25 ** Default: {{default_value}}
26 {{/default_value}}
27 {{#wiki_allowable_values}}
28 ** {{wiki_allowable_values}}
29 {{/wiki_allowable_values}}
30 {{/path_parameters}}
31 {{/has_path_parameters}}
32 {{#has_query_parameters}}
33
34 h3. Query parameters
35 {{#query_parameters}}
36 * {{name}}: _{{data_type}}_ -{{#required}} *(required)*{{/required}} {{{wiki_description}}}
37 {{#default_value}}
38 ** Default: {{default_value}}
39 {{/default_value}}
40 {{#wiki_allowable_values}}
41 ** {{wiki_allowable_values}}
42 {{/wiki_allowable_values}}
43 {{#allow_multiple}}
44 ** Allows comma separated values.
45 {{/allow_multiple}}
46 {{/query_parameters}}
47 {{/has_query_parameters}}
48 {{#has_body_parameter}}
49
50 h3. Body parameter
51 {{#body_parameter}}
52 * {{name}}: {{data_type}}{{#default_value}} = {{default_value}}{{/default_value}} -{{#required}} *(required)*{{/required}} {{{wiki_description}}}
53 {{#allow_multiple}}
54 ** Allows comma separated values.
55 {{/allow_multiple}}
56 {{/body_parameter}}
57 {{/has_body_parameter}}
58 {{#has_header_parameters}}
59
60 h3. Header parameters
61 {{#header_parameters}}
62 * {{name}}: {{data_type}}{{#default_value}} = {{default_value}}{{/default_value}} -{{#required}} *(required)*{{/required}} {{{wiki_description}}}
63 {{#allow_multiple}}
64 ** Allows comma separated values.
65 {{/allow_multiple}}
66 {{/header_parameters}}
67 {{/has_header_parameters}}
68 {{#has_error_responses}}
69
70 h3. Error Responses
71 {{#error_responses}}
72 * {{code}} - {{{wiki_reason}}}
73 {{/error_responses}}
74 {{/has_error_responses}}
75 {{/operations}}
76 {{/apis}}
77 {{/api_declaration}}