{% macro arguments(params, optional=False) -%} {% for item in params %}
{% if item is mapping %}

{{item.param}}{% if item.type %} {{ item.type }}{% endif %} {% if optional %}optional{% endif %}

{% if item.description %}

{{ item.description }}

{% else %} {% endif %} {% if item.paramOptions %}
This parameter is restricted to the following values:
{% for option in item.paramOptions %} {% if option is mapping %}
{{option.data}}
{% if option.meaning %}
{{ option.meaning }}
{% else %}
 
{% endif %} {% else %}
{{ option }}
 
{% endif %} {% endfor %}
{% endif %} {% else %}

{{item}} {% if optional %}optional{% endif %}

{% endif %}
{% endfor %} {%- endmacro %}
{% for apiTop in APIs %} {% set api = apiTop[0] %} {% set processors = apiTop[1] %}

{{api.friendlyName}} ({{api.name}})

{{api.description}}

{% for processorTmp in processors %} {% set processor = processorTmp[0] %} {% set HTTPType = processorTmp[1] %}
{% if version == "ROOT" %}

HTTP {{ HTTPType }} /{{api.endpoint}}

{% else %}

HTTP {{ HTTPType }} /v{{version}}/{{api.endpoint}}

{% endif %}
{% if HTTPType == "GET" %}

Request Arguments

{% elif HTTPType == "POST" %}

POST Arguments

{% endif %}
{% if processor.requiredParams %}{{ arguments(processor.requiredParams) }}{% endif %} {% if processor.optionalParams %}{{ arguments(processor.optionalParams, optional=True) }}{% endif %} {% if not processor.requiredParams and not processor.optionalParams %}

This API call does not specify any request params.

{% endif %}

Response Arguments


{% if processor.returnParams %}{{ arguments(processor.returnParams) }}{% endif %} {% if processor.optionalReturnParams %}{{ arguments(processor.optionalReturnParams, optional=True) }}{% endif %} {% if not processor.returnParams and not processor.optionalReturnParams %}

This API call does not specify any response params.

{% endif %}
{% endfor %} {% endfor %}