-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi-route-template.html
101 lines (101 loc) · 3.87 KB
/
api-route-template.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
<!DOCTYPE html>
<html data-navbar="navbar.html">
<head>
<title></title>
<link rel="stylesheet" href="/public/style.css">
<script async src="/public/highlight.min.js"></script>
<script src="/public/browser.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="UTF-8">
</head>
<body>
<a name="top" id="top"></a>
<div class="body-container">
<header>
<h1>Dashboard</h1>
<section id="navigation" class="navigation"></section>
</header>
<div class="section-container">
<section class="full">
<a name="content" id="content"></a>
<div class="content">
<h1 id="title"></h1>
<span class="nodejs" id="nodejs"></span>
<div class="api-via">
Located in <a id="subtitle"></a>
</div>
<div id="response-container">
<h2>Returns <span id="returns"></span></h2>
<pre class="response-code"><code data-language="json" id="response-code"></code></pre>
</div>
<div id="exceptions-container">
<a name="exceptions" id="exceptions"></a>
<h2>Exceptions</h2>
<p>These exceptions are thrown (NodeJS) or returned as JSON (HTTP) if you provide incorrect data or do not
meet the requirements:</p>
<table id="exceptions-table">
<tr>
<th>Exception</th>
<th>Circumstances</th>
</tr>
</table>
</div>
<div id="receives-container">
<a name="receives" id="receives"></a>
<h2>Receives</h2>
<p>API routes may receive parameters from the URL and POST supporting simple and multipart:</p>
<table id="receives-table">
<tr>
<th>Field</th>
<th>Value</th>
<th>Required</th>
<th>Type</th>
</tr>
</table>
</div>
<div id="redacts-container">
<a name="redacts" id="redacts"></a>
<h2>Redacts</h2>
<p>Some properties are redacted when accessing the objects:</p>
<ul id="redacts-list"></ul>
</div>
<div id="configuration-container">
<a name="configuration" id="configuration"></a>
<h2>Configuration</h2>
<p>This request behavior can be modified by these circumstances:</p>
<ul id="configuration-list"></ul>
</div>
<div class="source-code">
<a name="source" id="source"></a>
<h2>NodeJS source (<a id="github_source">edit on github</a>)</h2>
<p>If you see a problem with the source submit a pull request on Github.</p>
<pre><code data-language="js" id="source-code"></code></pre>
<a name="tests" id="tests"></a>
<h2>Test source (<a id="github_tests">edit on github</a>)</h2>
<p>Tests perform real HTTP requests against a running Dashboard server.</p>
<pre><code data-language="js" id="test-code"></code></pre>
</div>
<p><a class="skip" href="#top">Top of page</a></p>
</div>
</section>
</div>
</div>
<template id="property-item-template">
<li>${property.name}</li>
</template>
<template id="exception-template">
<tr>
<td id="description-${exception.id}" rowspan="${exception.rowSpan}">${exception.text}</td>
<td>${exception.note}</td>
</tr>
</template>
<template id="property-row-template">
<tr>
<td>${property.variable}</td>
<td>${property.value}</td>
<td>${property.required}</td>
<td>${property.type}</td>
</tr>
</template>
</body>
</html>