{{ link.title|default(link.name, True) }}

{{ link.method }} {{ link.url }}
{% if link.description %}

{{ link.description }}

{% endif %} {% if link.get_path_fields() %}

Path Parameters

The following parameters should be included in the URL path.

{% for field in link.get_path_fields() %} {% endfor %}
ParameterDescription
{{ field.name }}{% if field.required %} required{% endif %}{% if field.description or field.schema.description %}{{ field.description or field.schema.description }}{% endif %}
{% endif %} {% if link.get_query_fields() %}

Query Parameters

The following parameters should be included as part of a URL query string.

{% for field in link.get_query_fields() %} {% endfor %}
ParameterDescription
{{ field.name }}{% if field.required %} required{% endif %}{% if field.description or field.schema.description %}{{ field.description or field.schema.description }}{% endif %}
{% endif %} {% if link.get_body_field() %} {% set field=link.get_body_field() %} {% set expanded=link.get_expanded_body() %}

Request Body

The request body should be "{{ link.encoding }}" encoded, and should contain {% if expanded %}an object with the following attributes.{% else %}a single item.{% endif %}

{% if expanded %} {% for key, schema in expanded.items() %} {% endfor %} {% else %} {% endif %}
ParameterDescription
{{ key }}{% if key in field.schema.required %} required{% endif %}{% if schema.description %}{{ schema.description }}{% endif %}
{{ field.name }}{% if field.required %} required{% endif %}{% if field.description or field.schema.description %}{{ field.description or field.schema.description }}{% endif %}
{% endif %}
{% for language in langs %} {% set template = "apistar/langs/" + language + ".html" %} {% set is_selected = loop.first %} {% include template %} {% endfor %}