{{ yaml.name }}

{{ yaml.description | markdownify }}
{% for api in yaml.apis %}

{{ api.name }}

{{ api.method | upcase }}

{{ site.api_baseurl | escape }}{{ yaml.baseurl | escape }}{{ api.url | escape }}

{{ api.description | markdownify }}
Request
Response
{% if api.params.header %}

Headers

{% for param in api.params.header %} {% endfor %}
Field Type Description

{{ param.name }}

{% if param.is_required %}

required

{% else %}

optional

{% endif %}

{{ param.type }}
{{ param.description | markdownify }}
{% endif %} {% if api.params.path %}

Path Parameters

{% for param in api.params.path %} {% endfor %}
Field Type Description

{{ param.name }}

{% if param.is_required %}

required

{% else %}

optional

{% endif %}

{{ param.type }}
{{ param.description | markdownify }}
{% endif %} {% if api.params.query %}

Query Parameters

{% for param in api.params.query %} {% endfor %}
Field Type Description

{{ param.name }}

{% if param.is_required %}

required

{% else %}

optional

{% endif %}

{{ param.type }}
{{ param.description | markdownify }}
{% endif %} {% if api.params.body %}

Body Parameters

{% for param in api.params.body %} {% endfor %}
Field Type Description

{{ param.name }}

{% if param.is_required %}

required

{% else %}

optional

{% endif %}

{{ param.type }}
{{ param.description | markdownify }}
{% endif %}
{% if api.response.success %}

Success

{% for item in api.response.success %}

{{ item.status_code }} {% if item.status_code == 200 %} : Success {% endif %}

{% if item.description %}
{{ item.description | markdownify }}
{% endif %} {% if item.example %} 

                                {% endif %}
                            

                            {% endfor %}
                        

                        {% endif %}

                        {% if api.response.fail %}
                        
Fail

                        

                            {% for item in api.response.fail %}
                            

                                

                                    {{ item.status_code }}
                                    {% if item.status_code == 400 %}
                                    : Bad Request
                                    {% elsif item.status_code == 401 %}
                                    : Unauthorized
                                    {% elsif item.status_code == 403 %}
                                    : Forbidden
                                    {% elsif item.status_code == 404 %}
                                    : Not Found
                                    {% endif %}
                                

    
                                {% if item.description %}
                                
{{ item.description | markdownify }}

                                {% endif %}
    
                                {% if item.example %}
                                

                                {% endif %}
                            

                            {% endfor %}
                        

                        {% endif %}
                    

                

            

        

        {% endfor %}