{% if 'shell' in langs %}{% include "languages/shell.html" %}{% endif %} {% if 'python' in langs %}{% include "languages/python.html" %}{% endif %} {% if 'javascript' in langs %}{% include "languages/javascript.html" %}{% endif %}

{{ render_markdown(link.description) }}

HTTP Request

{{ link.action|upper }} {{ link.url }}

{% if get_fields('path', link ) %}

Path Parameters

The following parameters should be included in the URL path.

{% for field in get_fields('path', link ) %} {% endfor %}
ParameterDescription
{{ field.name }}{% if field.required %} required{% endif %}{% if field.description %}{{ field.description }}{% endif %}
{% endif %} {% if get_fields('query', link ) %}

Query Parameters

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

{% for field in get_fields('query', link ) %} {% endfor %}
ParameterDescription
{{ field.name }}{% if field.required %} required{% endif %}{% if field.description %}{{ field.description }}{% endif %}
{% endif %} {% if get_fields('header', link ) %}

Header Parameters

The following parameters should be included as HTTP headers.

{% for field in get_fields('header', link ) %} {% endfor %}
ParameterDescription
{{ field.name }}{% if field.required %} required{% endif %}{% if field.description %}{{ field.description }}{% endif %}
{% endif %} {% if get_fields('body', link ) %}

Request Body

The request body should be "{{ link.encoding }}" encoded, and should contain a single item.

{% for field in get_fields('body', link ) %} {% endfor %}
ParameterDescription
{{ field.name }}{% if field.required %} required{% endif %}{% if field.description %}{{ field.description }}{% endif %}
{% elif get_fields('form', link ) %}

Request Body

The request body should be a "{{ link.encoding }}" encoded object, containing the following items.

{% for field in get_fields('form', link ) %} {% endfor %}
ParameterDescription
{{ field.name }}{% if field.required %} required{% endif %}{% if field.description %}{{ field.description }}{% endif %}
{% endif %}