raml2html-werk-theme
Version:
a bulma and open-color based single-page theme that is easily searchable and offline-ready
698 lines (344 loc) • 13.7 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>Hello world 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">Hello world</h1>
</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>
<li>
<a href="#welcome">
Welcome
</a>
</li>
<li>
<a href="#chapter_two">
Chapter two
</a>
</li>
</ul>
<p class="menu-label">Resources</p>
<ul class="menu-list">
<li>
<a href="#helloworld">
/helloworld
</a>
<ul>
<li>
<a href="#helloworld">
/helloworld
</a>
</li>
<li>
<a href="#helloworld_test">
/helloworld/test
</a>
</li>
<li>
<a href="#helloworld__id_">
/helloworld/{id}
</a>
</li>
</ul>
</li>
</ul>
<p class="menu-label">Types</p>
<ul class="menu-list">
</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">http://example.com/{version}</code></pre>
<table class="table is-property-list">
<tbody>
<tr>
<th scope="row">
version
<div class="typedef-type">string,
one of [<code>1</code>], <strong class="typedef-required">required</strong></div>
</th>
<td>
</td>
</tr>
</tbody>
</table>
</section>
<section id="welcome" class="subsection" data-spy data-spy-parent="__all_docs">
<h2 class="title is-2">Welcome</h2>
<div class="content">
<p>Welcome to the Example Documentation. The Example API allows you
to do stuff. See also <a href="https://www.example.com">example.com</a>.</p>
</div>
</section>
<section id="chapter_two" class="subsection" data-spy data-spy-parent="__all_docs">
<h2 class="title is-2">Chapter two</h2>
<div class="content">
<p>More content here. Including <strong>bold</strong> text!</p>
</div>
</section>
</section>
<section id="__all_resources" class="section" data-spy>
<h2 class="title is-2">Resources</h2>
<div id="helloworld" class="group" data-spy data-spy-parent="__all_resources">
<header class="group-header">
<div class="group-title">
<h3 class="title is-3">/helloworld</h3>
</div>
<div class="content">
<p>This is the top level description for /helloworld.</p>
</div>
</header>
<!-- list of methods for /helloworld -->
<!-- begin of resource block for GET /helloworld -->
<div id="helloworld_get" class="group-endpoint" data-spy data-spy-parent="helloworld">
<header>
<h4 class="title is-4 is-anchored">
/helloworld
<a class="anchor" href="#helloworld_get">¶</a>
<div class="subtitle is-6">
<strong class="method is-get">GET</strong>
<span class="value">/helloworld</span>
</div>
</h4>
</header>
<div>
<h5 class="title is-5">Response</h5>
<div class="tabbable is-vertical" data-component="tabbable" data-tabbable-id="helloworld_get_response">
<header class="tabs is-boxed">
<ul class="tabbable-tabs" data-tabbable-tabs="helloworld_get_response">
<li>
<a id="helloworld_get_response_0" href="#helloworld_get_response_0" data-tab="0">
<span class="status"
data-code="200"></span>
</a>
</li>
</ul>
</header>
<div class="tabbable-contents" data-tabbable-contents="helloworld_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="helloworld_get_body_0" href="#helloworld_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">Examples</h6>
<ul>
<li>
<details>
<summary>Example</summary>
<pre><code>{
"message": "Hello world"
}</code></pre>
</details>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<!-- end of resource block for GET /helloworld -->
<!-- end of list of methods for /helloworld -->
<!-- list of methods for /helloworld/test -->
<span id="helloworld_test" class="group-resource-group-marker"
data-spy data-spy-parent="helloworld"></span>
<!-- begin of resource block for GET /helloworld/test -->
<div id="helloworld_test_get" class="group-endpoint" data-spy data-spy-parent="helloworld_test">
<header>
<h4 class="title is-4 is-anchored">
/helloworld/test
<a class="anchor" href="#helloworld_test_get">¶</a>
<div class="subtitle is-6">
<strong class="method is-get">GET</strong>
<span class="value">/helloworld/test</span>
</div>
</h4>
<div class="content">
<p>a sub resource</p>
</div>
</header>
<div>
</div>
</div>
<!-- end of resource block for GET /helloworld/test -->
<!-- end of list of methods for /helloworld/test -->
<!-- list of methods for /helloworld/{id} -->
<span id="helloworld__id_" class="group-resource-group-marker"
data-spy data-spy-parent="helloworld"></span>
<!-- begin of resource block for GET /helloworld/{id} -->
<div id="helloworld__id__get" class="group-endpoint" data-spy data-spy-parent="helloworld__id_">
<header>
<h4 class="title is-4 is-anchored">
/helloworld/{id}
<a class="anchor" href="#helloworld__id__get">¶</a>
<div class="subtitle is-6">
<strong class="method is-get">GET</strong>
<span class="value">/helloworld/{id}</span>
</div>
</h4>
</header>
<div>
<h5 class="title is-5">Request</h5>
<div class="indent">
<h6 class="title is-6">Path Variables</h6>
<table class="table is-property-list">
<tbody>
<tr>
<th scope="row">
id
<div class="typedef-type">string, minimum length: 1, maximum length: 10, <strong class="typedef-required">required</strong></div>
</th>
<td>
<div class="content">
<p>account identifier</p>
</div>
</td>
</tr>
</tbody>
</table>
<h6 class="title is-6">Request Headers</h6>
<table class="table is-property-list">
<tbody>
<tr>
<th scope="row">
Authorization
<div class="typedef-type">string, <strong class="typedef-required">required</strong></div>
</th>
<td>
<div class="content">
<p>Basic authentication header</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<!-- end of resource block for GET /helloworld/{id} -->
<!-- begin of resource block for PUT /helloworld/{id} -->
<div id="helloworld__id__put" class="group-endpoint" data-spy data-spy-parent="helloworld__id_">
<header>
<h4 class="title is-4 is-anchored">
/helloworld/{id}
<a class="anchor" href="#helloworld__id__put">¶</a>
<div class="subtitle is-6">
<strong class="method is-put">PUT</strong>
<span class="value">/helloworld/{id}</span>
</div>
</h4>
</header>
<div>
<h5 class="title is-5">Request</h5>
<div class="indent">
<h6 class="title is-6">Path Variables</h6>
<table class="table is-property-list">
<tbody>
<tr>
<th scope="row">
id
<div class="typedef-type">string, minimum length: 1, maximum length: 10, <strong class="typedef-required">required</strong></div>
</th>
<td>
<div class="content">
<p>account identifier</p>
</div>
</td>
</tr>
</tbody>
</table>
<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="helloworld__id__put_body_0" href="#helloworld__id__put_body_0" data-tab="0">
application/x-www-form-urlencoded
</a>
</li>
</ul>
</header>
<div class="tabbable-contents" data-tabbable-contents="undefined_body">
<div data-tab-content="0">
<h6 class="title is-6">Properties (object)</h6>
<table class="table is-property-list">
<tbody>
<tr>
<th scope="row">
name
<div class="typedef-type">string, <strong class="typedef-required">required</strong></div>
</th>
<td>
<div class="content">
<p>name on account</p>
</div>
</td>
</tr>
<tr>
<th scope="row">
gender
<div class="typedef-type">string,
one of [<code>male</code>, <code>female</code>], <strong class="typedef-required">required</strong></div>
</th>
<td>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
</div>
<!-- end of resource block for PUT /helloworld/{id} -->
<!-- end of list of methods for /helloworld/{id} -->
</div>
</section>
<section id="__all_types" class="section" data-spy>
<h2 class="title is-2">Type Reference</h2>
</section>
</main>
</div>
</div>
</div>
<script src="./assets/docs.js"></script>
</body>
</html>