raml2html-werk-theme
Version:
a bulma and open-color based single-page theme that is easily searchable and offline-ready
448 lines (217 loc) • 8.49 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Test API documentation</title>
<meta name="generator" content="https://github.com/raml2html/raml2html 7.0.0">
<link rel="stylesheet" href="./assets/docs.css">
</head>
<body data-component="scroll-spy">
<header class="hero">
<div class="hero-body">
<h1 class="title is-1">Test</h1>
<p class="subtitle has-priority-3">Test of array support</p>
</div>
</header>
<div>
<div class="columns">
<div class="column is-nav is-narrow-tablet is-12-mobile" data-component="menu">
<aside class="sidebar">
<nav class="menu section">
<p class="menu-label">Info</p>
<ul class="menu-list">
<li>
<a href="#__basic_information_docs">
Basic Information
</a>
</li>
</ul>
<p class="menu-label">Resources</p>
<ul class="menu-list">
<li>
<a href="#foos">
/foos
</a>
</li>
</ul>
<p class="menu-label">Types</p>
<ul class="menu-list">
<li>
<a href="#type__Foo">
Foo
</a>
</li>
<li>
<a href="#type__Foos">
Foos
</a>
</li>
<li>
<a href="#type__Result">
Result
</a>
</li>
</ul>
</nav>
</aside>
</div>
<div class="column">
<main class="main-content">
<section id="__all_docs" class="section" data-spy>
<section id="__basic_information_docs" class="subsection" data-spy data-spy-parent="__all_docs">
<h2 class="title is-2">Basic Information</h2>
<h3 class="title is-3">Endpoint</h3>
<pre><code class="value" data-hljs="disabled">https://exmaple.com/{version}</code></pre>
<table class="table is-property-list">
<tbody>
<tr>
<th scope="row">
version
<div class="typedef-type">string,
one of [<code>v1</code>], <strong class="typedef-required">required</strong></div>
</th>
<td>
</td>
</tr>
</tbody>
</table>
</section>
</section>
<section id="__all_resources" class="section" data-spy>
<h2 class="title is-2">Resources</h2>
<div id="foos" class="group" data-spy data-spy-parent="__all_resources">
<header class="group-header">
<div class="group-title">
<h3 class="title is-3">/foos</h3>
</div>
</header>
<!-- list of methods for /foos -->
<!-- begin of resource block for GET /foos -->
<div id="foos_get" class="group-endpoint" data-spy data-spy-parent="foos">
<header>
<h4 class="title is-4 is-anchored">
/foos
<a class="anchor" href="#foos_get">¶</a>
<div class="subtitle is-6">
<strong class="method is-get">GET</strong>
<span class="value">/foos</span>
</div>
</h4>
</header>
<div>
<h5 class="title is-5">Response</h5>
<div class="tabbable is-vertical" data-component="tabbable" data-tabbable-id="foos_get_response">
<header class="tabs is-boxed">
<ul class="tabbable-tabs" data-tabbable-tabs="foos_get_response">
<li>
<a id="foos_get_response_0" href="#foos_get_response_0" data-tab="0">
<span class="status"
data-code="200"></span>
</a>
</li>
</ul>
</header>
<div class="tabbable-contents" data-tabbable-contents="foos_get_response">
<div data-tab-content="0">
<div class="tabbable" data-component="tabbable" data-tabbable-id="undefined_body">
<header class="tabs is-boxed">
<strong class="title is-6">Body</strong>
<ul class="tabbable-tabs" data-tabbable-tabs="undefined_body">
<li>
<a id="foos_get_body_0" href="#foos_get_body_0" data-tab="0">
application/json
</a>
</li>
</ul>
</header>
<div class="tabbable-contents" data-tabbable-contents="undefined_body">
<div data-tab-content="0">
<h6 class="title is-6">Properties (<a href="#type__Result" title="Jump to 'Result' type docs"
data-component="preview">Result</a>)</h6>
<table class="table is-property-list">
<tbody>
<tr>
<th scope="row">
a
<div class="typedef-type">string, <strong class="typedef-required">required</strong></div>
</th>
<td>
</td>
</tr>
<tr>
<th scope="row">
foos
<div class="typedef-type">Array of <a href="#type__Foo" title="Jump to 'Foo' type docs"
data-component="preview">Foo</a>, <strong class="typedef-required">required</strong></div>
</th>
<td>
<details>
<summary>Foo[]
</summary>
<table class="table is-property-list">
<tbody>
<tr>
<th scope="row">
id
<div class="typedef-type">string, <strong class="typedef-required">required</strong></div>
</th>
<td>
</td>
</tr>
</tbody>
</table>
</details>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<!-- end of resource block for GET /foos -->
<!-- end of list of methods for /foos -->
</div>
</section>
<section id="__all_types" class="section" data-spy>
<h2 class="title is-2">Type Reference</h2>
<div class="subsection" id="type__Foo" data-spy data-spy-parent="__all_types">
<h3 class="title is-3 is-anchored"
>
Foo
<a class="anchor" href="#type__Foo">¶</a>
</h3>
</div>
<div class="subsection" id="type__Foos" data-spy data-spy-parent="__all_types">
<h3 class="title is-3 is-anchored"
>
Foos
<a class="anchor" href="#type__Foos">¶</a>
</h3>
<h4 class="title is-6">Type Information</h4>
<div class="typedef-standalone">
<div class="typedef-type">Array of <a href="#type__Foo" title="Jump to 'Foo' type docs"
data-component="preview">Foo</a></div>
</div>
</div>
<div class="subsection" id="type__Result" data-spy data-spy-parent="__all_types">
<h3 class="title is-3 is-anchored"
>
Result
<a class="anchor" href="#type__Result">¶</a>
</h3>
</div>
</section>
</main>
</div>
</div>
</div>
<script src="./assets/docs.js"></script>
</body>
</html>