Back to Qgis

API description

resources/server/api/ogc/templates/wfs3/getApiDescription.html

latest1.8 KB
Original Source

{% include "header.html" %}

API description

Info

Description{{ info.description }}Title{{ info.title }}Contact email{{ info.contact.email }}Contact name{{ info.contact.name }}

Paths

{% for path, path_info in paths %} {% for method, method_data in path_info %}

{{ method }} {{ path }} {{ method_data.summary }}

OperationId{{ method_data.operationId }} Tags{{ method_data.tags }} Description{{ method_data.description }} {% if existsIn(method_data, "parameters") %} Parameters

NameDescriptionType
{% for param in method_data.parameters %} {% if existsIn(param, "name") %}{{ param.name }}{{ nl2br( param.description ) }}
{% else %} {% for comp_param in component_parameter( param ) %}{{ comp_param.name }}{{ nl2br( comp_param.description ) }}
{% endfor %} {% endif %} {% endfor %}
{% endif %} Responses{{ method_data.responses}}

{% endfor %} {% endfor %}

Models

{% for schema_name, schema_model in components.schemas %}

{{ schema_name }}

Type{{ schema_model.type }} Properties

NameDescriptionTypeExample
{% for property_name, property_data in schema_model.properties %} {% if existsIn(property_data, "example") and existsIn(property_data, "description") %}{{ property_name }}{{ property_data.description }}{{ property_data.type }}
{% for example in property_data.example %} - {{ example }}
{% endfor %}
{% else %} {{ property_data.example }} {% endif %}
{% else %}{{ property_name }}{{ property_data }}{% endif %} {% endfor %}

Required {% for req in schema_model.required %} - {{ req }} {% endfor %}

{% endfor %}

{% include "footer.html" %}