Files
stacks-puppet-node/api/templates/_docsection.html

51 lines
2.1 KiB
HTML

{% macro docsection(api_call, server_url) %}
<div>
<section>
<div class="container pull-left col-sm-12 segment-wrapper" id="{{ api_call.anchor_tag }}">
<div class="container-fluid pull-left col-sm-6 segment-zone">
<div class="seg-zone-wrap">
<h3>{{ api_call.title }}</h3>
<p>{{ api_call.description }}</p>
<h5 class="doc-component">parameters</h5>
<div class="queryparameters">
{% for parameter in api_call.parameters %}
<div class="parameter">
<div class="parameter-label">
{{ parameter.name }}
{% if parameter.optional %}
(optional)
{% endif %}
</div>
<div class="parameter-description">{{ parameter.description }}</div>
</div>
{% endfor %}
{% if not api_call.parameters %}
-
{% endif %}
</div>
<h4 class="doc-component">returns</h4>
<p>{{ api_call.response_description }}</p>
</div>
{% if api_call.tryit_pathname %}
<p class="doc-component">
<a href="{{ api_call.tryit_pathname }}" class="btn btn-default" target="_self">Try it out</a>
</p>
{% endif %}
</div>
<div class="segment-code" id="identifier">
<div class="seg-code-wrap">
<h4>Definition</h4>
<pre><code class="http">{{ api_call.method }} {{ server_url }}{{ api_call.path_template }}</code></pre>
<h4>Example Request</h4>
<pre><code class="bash">curl {{ server_url}}{{ api_call.example_request_bash }}</code></pre>
<h4>Example Response</h4>
<pre><code class="json">{{ api_call.example_response }}</code></pre>
</div>
</div>
</div>
</section>
</div>
{% endmacro %}