{%- import "helper/util.html" as util %} {%- import "helper/diff.html" as diff %}
{% if method.description %}
{% for description in method.description %}
{{- description.value -}}
{%- endfor -%}
{%- endif -%}
Request:
Resource:
{% for uri in method.full_uri %} {{ uri.value }} {%- endfor -%} {%- if method.request_uri_parameters %}
URI Parameters:
{%- call util.render_table([{"name": "Parameter"}, {"width": "160px", "name": "Type"}, {"width": "70px", "name": "Optional"}, {"width": "50%", "name": "Description"}]) %} {%- for parameter in method.request_uri_parameters|sort %} {{ util.none_to_empty(parameter.value.name) }} {%- if parameter.value.type != None %} {%- if not parameter.value.is_internal %} {{parameter.value.type}} {%- else -%} {{- parameter.value.type -}} {%- endif -%} {%- endif -%} {% if parameter.value.optional %}Optional{% endif %} {{ util.none_to_empty(parameter.value.description) }} {%- endfor %} {%- endcall %} {%- endif %} {%- if method.request_query_string_parameters %}
Query String Parameters:
{%- call util.render_table([{"name": "Parameter"}, {"width": "160px", "name": "Type"}, {"width": "70px", "name": "Optional"}, {"width": "50%", "name": "Description"}]) %} {%- for parameter in method.request_query_string_parameters|sort %} {{ util.none_to_empty(parameter.value.name) }} {%- if parameter.value.type != None %} {%- if not parameter.value.is_internal %} {{parameter.value.type}} {%- else -%} {{- parameter.value.type -}} {%- endif -%} {%- endif -%} {% if parameter.value.optional %}Optional{% endif %} {{ util.none_to_empty(parameter.value.description) }} {%- endfor %} {%- endcall %} {%- endif %} {%- if method.request_headers %}
Headers:
{%- call util.render_table([{"name": "Parameter"}, {"width": "160px", "name": "Type"}, {"width": "50%", "name": "Description"}]) %} {%- for parameter in method.request_headers|sort %} {{ util.none_to_empty(parameter.value.name) }} {%- if parameter.value.type != None %} {%- if not parameter.value.is_internal %} {{parameter.value.type}} {%- else -%} {{- parameter.value.type -}} {%- endif -%} {%- endif -%} {{ util.none_to_empty(parameter.value.description) }} {%- endfor %} {%- endcall %} {%- endif %} {%- if method.request_body %}
Body:
{{ diff.diff_code_commented(method.request_body) }}
{%- endif %}
Response:
{%- if method.response_body %}
Body:
{{ diff.diff_code_commented(method.response_body) }}
{%- endif %} {%- if method.response_codes %}
Codes:
{%- call util.render_table([{"width": "50px", "name": "Code"}, {"name": "Message"}, {"width": "50%", "name": "Description"}]) %} {%- for parameter in method.response_codes|sort %} {{ util.none_to_empty(parameter.value.code) }} {{ util.none_to_empty(parameter.value.message) }} {{ util.none_to_empty(parameter.value.description) }} {%- endfor %} {%- endcall %} {%- endif %}