mirror of
https://github.com/danbulant/api_docs
synced 2026-05-19 04:08:40 +00:00
Upload builded docs
This commit is contained in:
Daniel Bulant
GitHub
parent
c4b4c0b8f8
commit
b9d593d39e
15 changed files with 775 additions and 231 deletions
BIN
fonts/slate-33847ce5.woff
Normal file
BIN
fonts/slate-33847ce5.woff
Normal file
Binary file not shown.
BIN
fonts/slate-7b7da4fe.ttf
Normal file
BIN
fonts/slate-7b7da4fe.ttf
Normal file
Binary file not shown.
BIN
fonts/slate-cfc9d06b.eot
Normal file
BIN
fonts/slate-cfc9d06b.eot
Normal file
Binary file not shown.
BIN
fonts/slate-ddd488db.woff2
Normal file
BIN
fonts/slate-ddd488db.woff2
Normal file
Binary file not shown.
14
fonts/slate-e55b8307.svg
Normal file
14
fonts/slate-e55b8307.svg
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
<?xml version="1.0" standalone="no"?>
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd" >
|
||||
<svg xmlns="http://www.w3.org/2000/svg">
|
||||
<metadata>Generated by IcoMoon</metadata>
|
||||
<defs>
|
||||
<font id="slate" horiz-adv-x="1024">
|
||||
<font-face units-per-em="1024" ascent="960" descent="-64" />
|
||||
<missing-glyph horiz-adv-x="1024" />
|
||||
<glyph unicode=" " d="" horiz-adv-x="512" />
|
||||
<glyph unicode="" d="M438.857 877.714q119.429 0 220.286-58.857t159.714-159.714 58.857-220.286-58.857-220.286-159.714-159.714-220.286-58.857-220.286 58.857-159.714 159.714-58.857 220.286 58.857 220.286 159.714 159.714 220.286 58.857zM512 165.143v108.571q0 8-5.143 13.429t-12.571 5.429h-109.714q-7.429 0-13.143-5.714t-5.714-13.143v-108.571q0-7.429 5.714-13.143t13.143-5.714h109.714q7.429 0 12.571 5.429t5.143 13.429zM510.857 361.714l10.286 354.857q0 6.857-5.714 10.286-5.714 4.571-13.714 4.571h-125.714q-8 0-13.714-4.571-5.714-3.429-5.714-10.286l9.714-354.857q0-5.714 5.714-10t13.714-4.286h105.714q8 0 13.429 4.286t6 10z" />
|
||||
<glyph unicode="" d="M585.143 164.571v91.429q0 8-5.143 13.143t-13.143 5.143h-54.857v292.571q0 8-5.143 13.143t-13.143 5.143h-182.857q-8 0-13.143-5.143t-5.143-13.143v-91.429q0-8 5.143-13.143t13.143-5.143h54.857v-182.857h-54.857q-8 0-13.143-5.143t-5.143-13.143v-91.429q0-8 5.143-13.143t13.143-5.143h256q8 0 13.143 5.143t5.143 13.143zM512 676.571v91.429q0 8-5.143 13.143t-13.143 5.143h-109.714q-8 0-13.143-5.143t-5.143-13.143v-91.429q0-8 5.143-13.143t13.143-5.143h109.714q8 0 13.143 5.143t5.143 13.143zM877.714 438.857q0-119.429-58.857-220.286t-159.714-159.714-220.286-58.857-220.286 58.857-159.714 159.714-58.857 220.286 58.857 220.286 159.714 159.714 220.286 58.857 220.286-58.857 159.714-159.714 58.857-220.286z" />
|
||||
<glyph unicode="" d="M733.714 531.428q0 16-10.286 26.286l-52 51.429q-10.857 10.857-25.714 10.857t-25.714-10.857l-233.143-232.571-129.143 129.143q-10.857 10.857-25.714 10.857t-25.714-10.857l-52-51.429q-10.286-10.286-10.286-26.286 0-15.429 10.286-25.714l206.857-206.857q10.857-10.857 25.714-10.857 15.429 0 26.286 10.857l310.286 310.286q10.286 10.286 10.286 25.714zM877.714 438.857q0-119.429-58.857-220.286t-159.714-159.714-220.286-58.857-220.286 58.857-159.714 159.714-58.857 220.286 58.857 220.286 159.714 159.714 220.286 58.857 220.286-58.857 159.714-159.714 58.857-220.286z" />
|
||||
<glyph unicode="" d="M658.286 475.428q0 105.714-75.143 180.857t-180.857 75.143-180.857-75.143-75.143-180.857 75.143-180.857 180.857-75.143 180.857 75.143 75.143 180.857zM950.857 0q0-29.714-21.714-51.429t-51.429-21.714q-30.857 0-51.429 21.714l-196 195.429q-102.286-70.857-228-70.857-81.714 0-156.286 31.714t-128.571 85.714-85.714 128.571-31.714 156.286 31.714 156.286 85.714 128.571 128.571 85.714 156.286 31.714 156.286-31.714 128.571-85.714 85.714-128.571 31.714-156.286q0-125.714-70.857-228l196-196q21.143-21.143 21.143-51.429z" horiz-adv-x="951" />
|
||||
</font></defs></svg>
|
||||
|
After Width: | Height: | Size: 2.9 KiB |
BIN
images/logo-1e815a84.png
Normal file
BIN
images/logo-1e815a84.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
BIN
images/navbar-cad8cdcb.png
Normal file
BIN
images/navbar-cad8cdcb.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 96 B |
7
includes/endpoints
Normal file
7
includes/endpoints
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
<h1 id='endpoints'>Endpoints</h1><h2 id='bakalari'>Bakalari</h2>
|
||||
<blockquote>
|
||||
<p>Example request</p>
|
||||
</blockquote>
|
||||
<pre class="highlight shell tab-shell"><code>curl <span class="s2">"https://api.danbulant.eu/v1/bakalari/rozvrh/user/domain.tld/SecretPassword123"</span>
|
||||
</code></pre>
|
||||
<p>Tries getting the info from Bakalari API.</p>
|
||||
4
includes/libraries
Normal file
4
includes/libraries
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
<h1 id='libraries'>Libraries</h1><h2 id='js'>JS</h2>
|
||||
<p><em>Currently unavailable, but planned.</em>
|
||||
This library simplifies usage. It uses <code>got</code> under the hood for simplified request handling, and always returns promise.
|
||||
Responses are just parsed JSON (as of now, but classes may be implemented in future).</p>
|
||||
288
includes/responses
Normal file
288
includes/responses
Normal file
|
|
@ -0,0 +1,288 @@
|
|||
<h1 id='response-format'>Response format</h1><h2 id='fields'>Fields</h2>
|
||||
<p>Response is currently always in JSON (but we might support XML and JSONP if there will be someone who might use it). Response always has these fields:</p>
|
||||
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Purpose</th>
|
||||
<th>example content</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>code</td>
|
||||
<td>Contains the HTTP code</td>
|
||||
<td><code>200</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>message</td>
|
||||
<td>A string containing sample message.</td>
|
||||
<td><code>Success, see type.</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>type</td>
|
||||
<td>A string with the type of returned data</td>
|
||||
<td><code>ping_response</code></td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
|
||||
<p>Response may have additional fields, such as <code>url</code> or <code>data</code>. These depends on the type.</p>
|
||||
<h2 id='types'>Types</h2>
|
||||
<p>Types that start with <code>e_</code> are <em>always</em> errors. The following type can be retrieved:</p>
|
||||
<h3 id='e_invalid_key-key-only-endpoints'><code>e_invalid_key</code> | Key-only endpoints</h3>
|
||||
<p>The key given is invalid and cannot be used.</p>
|
||||
<h3 id='e_missing_query'><code>e_missing_query</code> | *</h3>
|
||||
<p>Request lacks GET query string, which is required by the endpoint.</p>
|
||||
<h3 id='e_invalid_query'><code>e_invalid_query</code> | *</h3>
|
||||
<p>Request has invalid fields/missing fields/invalid values. See <code>message</code> in the response for more information.</p>
|
||||
<h3 id='e_empty_response'><code>e_empty_response</code> | *</h3>
|
||||
<p>Request succeeded, but the response provided by the endpoint was empty.</p>
|
||||
<h3 id='e_cannot_get'><code>e_cannot_get</code> | *</h3>
|
||||
<p>Request failed while trying to fetch external data.</p>
|
||||
<h3 id='e_generic'><code>e_generic</code> | *</h3>
|
||||
<p>Unknown error.</p>
|
||||
<h3 id='e_ester_error-ester'><code>e_ester_error</code> | Ester</h3>
|
||||
<p>An error occured inside Ester API. See <code>data</code> field (contains response from Ester API).</p>
|
||||
<h3 id='e_bakalari_missing_school-bakalari'><code>e_bakalari_missing_school</code> | Bakalari</h3>
|
||||
<p>Error occured during fetching data from the given domain, which usually means the schoold doesn't exists or has private API (currently no known school has private API).</p>
|
||||
<h3 id='e_bakalari_missing_user-bakalari'><code>e_bakalari_missing_user</code> | Bakalari</h3>
|
||||
<p>Request to school succeeded, but the user doesn't exists.</p>
|
||||
<h3 id='e_missing_subreddit-reddit'><code>e_missing_subreddit</code> | Reddit</h3>
|
||||
<p>Couldn't fetch subreddit. Subreddit may be NSFW (which are currently unsupported) or private or just simply doesn't exists.</p>
|
||||
<h3 id='e_reddit_failed-reddit'><code>e_reddit_failed</code> | Reddit</h3>
|
||||
<p>Reddit returned invalid response and/or error response.</p>
|
||||
<h3 id='e_neko_type-nekos'><code>e_neko_type</code> | Nekos</h3>
|
||||
<p>Unknown neko type.</p>
|
||||
|
||||
<hr>
|
||||
|
||||
<blockquote>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success, nothing to do"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"generic"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre><h3 id='generic'><code>generic</code> | *</h3>
|
||||
<p>A response containing only the default 3 fields.</p>
|
||||
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
|
||||
<blockquote>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success, see types"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"neko_list"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"types"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="s2">"..."</span><span class="w"> </span><span class="p">]</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre><h3 id='neko_list-nekos'><code>neko_list</code> | Nekos</h3>
|
||||
<p>List of available <code>neko</code> endpoints.</p>
|
||||
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
|
||||
<blockquote>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">404</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ICe API in development, see later"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ice_response"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{}</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre><h3 id='ice_response-ice'><code>ice_response</code> | Ice</h3>
|
||||
<p>A generic bot response.</p>
|
||||
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
|
||||
<blockquote>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ice_http_code_response"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"http"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"standart"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"OK"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action."</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"choices"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="s2">"source"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Wikipedia"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre><h3 id='ice_http_code_response-http'><code>ice_http_code_response</code> | Http</h3>
|
||||
<p>A response containing information about given http code.</p>
|
||||
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
|
||||
<blockquote>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">400</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Missing parameter code. Use it as /http/:code"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"e_ice_http_missing_code"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre><h3 id='ice_http_code_list-ice'><code>ice_http_code_list</code> | Ice</h3>
|
||||
<p>A <em>planned</em> response to list all available HTTP codes.</p>
|
||||
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
<h3 id='pushr_response-pushr'><code>pushr_response</code> | Pushr</h3>
|
||||
<p>A response from Pushr API (danbulant.eu API acts as pass-through for this).</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success, see reddit"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"reddit_response"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"reddit"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"I really ininterested"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"image"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://imgur.com/tLBzS1h.jpg"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"author"</span><span class="p">:</span><span class="w"> </span><span class="s2">"nickjayr"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"authorIcon"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://www.redditstatic.com/avatars/avatar_default_17_0DD3BB.png"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"link"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://reddit.com/r/memes/comments/ey2hkb/i_really_ininterested/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre><h3 id='redddit_response-reddit'><code>redddit_response</code> | Reddit</h3>
|
||||
<p>Response from reddit API containing <code>reddit</code> object.</p>
|
||||
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
|
||||
<blockquote>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success, see response"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"path"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ester_response"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Čau!"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"user"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Daniel"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="s2">"text"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Čau!"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre><h3 id='ester_response-ester'><code>ester_response</code> | Ester</h3>
|
||||
<p>A generic response from Ester API.</p>
|
||||
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
|
||||
<blockquote>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bakalari_response"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"verze"</span><span class="p">:</span><span class="w"> </span><span class="s2">"17/18.20191219"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"jmeno"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[NAME HIDDEN]"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"typ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"R"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"strtyp"</span><span class="p">:</span><span class="w"> </span><span class="s2">"rodič"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"skola"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[SCHOOL REDACTED]"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"typskoly"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"trida"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.A"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"rocnik"</span><span class="p">:</span><span class="w"> </span><span class="mi">-1</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"moduly"</span><span class="p">:</span><span class="w"> </span><span class="s2">"*znamky*predvidac*rozvrh*predmety*vyuka*ukoly*akce*suplovani*absence*pololetni*prijate*odeslane*nastenka*setread*setok*komsend*komenslisty*komdel*"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"params"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"newmarkdays"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="s2">"result"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre><h3 id='bakalari_response-bakalari'><code>bakalari_response</code> | Bakalari</h3>
|
||||
<p>Response from the <code>bakalari</code> API. Format depends on the bakalari response (e.g., try the desired info in browser to see, as danbulant.eu only converts xml to json).</p>
|
||||
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
|
||||
<blockquote>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success, see url"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"image"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://i.imgur.com/wVUpmao.jpg"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre><h3 id='image'><code>image</code> | *</h3>
|
||||
<p>Generic image response. The actual image is on adress inside the provided <code>url</code> field.</p>
|
||||
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
529
index.html
529
index.html
|
|
@ -196,24 +196,22 @@
|
|||
color: #f92672;
|
||||
}
|
||||
</style>
|
||||
<link href="stylesheets/screen.css" rel="stylesheet" media="screen" />
|
||||
<link href="stylesheets/print.css" rel="stylesheet" media="print" />
|
||||
<script src="javascripts/all.js"></script>
|
||||
<link href="stylesheets/screen-a1ce949a.css" rel="stylesheet" media="screen" />
|
||||
<link href="stylesheets/print-bccf8c07.css" rel="stylesheet" media="print" />
|
||||
<script src="javascripts/all-c5541673.js"></script>
|
||||
</head>
|
||||
|
||||
<body class="index" data-languages="["shell","ruby","python","javascript"]">
|
||||
<body class="index" data-languages="["shell","javascript"]">
|
||||
<a href="#" id="nav-button">
|
||||
<span>
|
||||
NAV
|
||||
<img src="images/navbar.png" alt="Navbar" />
|
||||
<img src="images/navbar-cad8cdcb.png" alt="Navbar" />
|
||||
</span>
|
||||
</a>
|
||||
<div class="toc-wrapper">
|
||||
<img src="images/logo.png" class="logo" alt="Logo" />
|
||||
<img src="images/logo-1e815a84.png" class="logo" alt="Logo" />
|
||||
<div class="lang-selector">
|
||||
<a href="#" data-language-name="shell">shell</a>
|
||||
<a href="#" data-language-name="ruby">ruby</a>
|
||||
<a href="#" data-language-name="python">python</a>
|
||||
<a href="#" data-language-name="javascript">javascript</a>
|
||||
</div>
|
||||
<div class="search">
|
||||
|
|
@ -225,278 +223,347 @@
|
|||
<a href="#introduction" class="toc-h1 toc-link" data-title="Introduction">Introduction</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#authentication" class="toc-h1 toc-link" data-title="Authentication">Authentication</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#kittens" class="toc-h1 toc-link" data-title="Kittens">Kittens</a>
|
||||
<a href="#response-format" class="toc-h1 toc-link" data-title="Response format">Response format</a>
|
||||
<ul class="toc-list-h2">
|
||||
<li>
|
||||
<a href="#get-all-kittens" class="toc-h2 toc-link" data-title="Get All Kittens">Get All Kittens</a>
|
||||
<a href="#fields" class="toc-h2 toc-link" data-title="Fields">Fields</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#get-a-specific-kitten" class="toc-h2 toc-link" data-title="Get a Specific Kitten">Get a Specific Kitten</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#delete-a-specific-kitten" class="toc-h2 toc-link" data-title="Delete a Specific Kitten">Delete a Specific Kitten</a>
|
||||
<a href="#types" class="toc-h2 toc-link" data-title="Types">Types</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#errors" class="toc-h1 toc-link" data-title="Errors">Errors</a>
|
||||
<a href="#libraries" class="toc-h1 toc-link" data-title="Libraries">Libraries</a>
|
||||
<ul class="toc-list-h2">
|
||||
<li>
|
||||
<a href="#js" class="toc-h2 toc-link" data-title="JS">JS</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#endpoints" class="toc-h1 toc-link" data-title="Endpoints">Endpoints</a>
|
||||
<ul class="toc-list-h2">
|
||||
<li>
|
||||
<a href="#bakalari" class="toc-h2 toc-link" data-title="Bakalari">Bakalari</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="toc-footer">
|
||||
<li><a href='#'>Sign Up for a Developer Key</a></li>
|
||||
<li><a href='https://github.com/lord/slate'>Documentation Powered by Slate</a></li>
|
||||
<li><a href='https://discord.gg/dZtq4Qu'>Contact us for a Developer Key</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="page-wrapper">
|
||||
<div class="dark-box"></div>
|
||||
<div class="content">
|
||||
<h1 id='introduction'>Introduction</h1>
|
||||
<p>Welcome to the Kittn API! You can use our API to access Kittn API endpoints, which can get information on various cats, kittens, and breeds in our database.</p>
|
||||
<p>Danbulant API is a wrapper around all of APIs available at danbulant.eu.
|
||||
Most of endpoints currently don't require developer key, but for future use, we suggest still getting one. You won't do anything bad if you try to reach a free endpoint with developer key. You can contact us <a href="https://discord.gg/dZtq4Qu">here</a> on our discord server to get information about getting one.</p>
|
||||
<h1 id='response-format'>Response format</h1><h2 id='fields'>Fields</h2>
|
||||
<p>Response is currently always in JSON (but we might support XML and JSONP if there will be someone who might use it). Response always has these fields:</p>
|
||||
|
||||
<p>We have language bindings in Shell, Ruby, Python, and JavaScript! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.</p>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Purpose</th>
|
||||
<th>example content</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>code</td>
|
||||
<td>Contains the HTTP code</td>
|
||||
<td><code>200</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>message</td>
|
||||
<td>A string containing sample message.</td>
|
||||
<td><code>Success, see type.</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>type</td>
|
||||
<td>A string with the type of returned data</td>
|
||||
<td><code>ping_response</code></td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
|
||||
<p>Response may have additional fields, such as <code>url</code> or <code>data</code>. These depends on the type.</p>
|
||||
<h2 id='types'>Types</h2>
|
||||
<p>Types that start with <code>e_</code> are <em>always</em> errors. The following type can be retrieved:</p>
|
||||
<h3 id='e_invalid_key-key-only-endpoints'><code>e_invalid_key</code> | Key-only endpoints</h3>
|
||||
<p>The key given is invalid and cannot be used.</p>
|
||||
<h3 id='e_missing_query'><code>e_missing_query</code> | *</h3>
|
||||
<p>Request lacks GET query string, which is required by the endpoint.</p>
|
||||
<h3 id='e_invalid_query'><code>e_invalid_query</code> | *</h3>
|
||||
<p>Request has invalid fields/missing fields/invalid values. See <code>message</code> in the response for more information.</p>
|
||||
<h3 id='e_empty_response'><code>e_empty_response</code> | *</h3>
|
||||
<p>Request succeeded, but the response provided by the endpoint was empty.</p>
|
||||
<h3 id='e_cannot_get'><code>e_cannot_get</code> | *</h3>
|
||||
<p>Request failed while trying to fetch external data.</p>
|
||||
<h3 id='e_generic'><code>e_generic</code> | *</h3>
|
||||
<p>Unknown error.</p>
|
||||
<h3 id='e_ester_error-ester'><code>e_ester_error</code> | Ester</h3>
|
||||
<p>An error occured inside Ester API. See <code>data</code> field (contains response from Ester API).</p>
|
||||
<h3 id='e_bakalari_missing_school-bakalari'><code>e_bakalari_missing_school</code> | Bakalari</h3>
|
||||
<p>Error occured during fetching data from the given domain, which usually means the schoold doesn't exists or has private API (currently no known school has private API).</p>
|
||||
<h3 id='e_bakalari_missing_user-bakalari'><code>e_bakalari_missing_user</code> | Bakalari</h3>
|
||||
<p>Request to school succeeded, but the user doesn't exists.</p>
|
||||
<h3 id='e_missing_subreddit-reddit'><code>e_missing_subreddit</code> | Reddit</h3>
|
||||
<p>Couldn't fetch subreddit. Subreddit may be NSFW (which are currently unsupported) or private or just simply doesn't exists.</p>
|
||||
<h3 id='e_reddit_failed-reddit'><code>e_reddit_failed</code> | Reddit</h3>
|
||||
<p>Reddit returned invalid response and/or error response.</p>
|
||||
<h3 id='e_neko_type-nekos'><code>e_neko_type</code> | Nekos</h3>
|
||||
<p>Unknown neko type.</p>
|
||||
|
||||
<hr>
|
||||
|
||||
<p>This example API documentation page was created with <a href="https://github.com/lord/slate">Slate</a>. Feel free to edit it and use it as a base for your own API's documentation.</p>
|
||||
<h1 id='authentication'>Authentication</h1>
|
||||
<blockquote>
|
||||
<p>To authorize, use this code:</p>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight ruby tab-ruby"><code><span class="nb">require</span> <span class="s1">'kittn'</span>
|
||||
<pre class="highlight json tab-json"><code><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success, nothing to do"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"generic"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre><h3 id='generic'><code>generic</code> | *</h3>
|
||||
<p>A response containing only the default 3 fields.</p>
|
||||
|
||||
<span class="n">api</span> <span class="o">=</span> <span class="no">Kittn</span><span class="o">::</span><span class="no">APIClient</span><span class="p">.</span><span class="nf">authorize!</span><span class="p">(</span><span class="s1">'meowmeowmeow'</span><span class="p">)</span>
|
||||
</code></pre><pre class="highlight python tab-python"><code><span class="kn">import</span> <span class="nn">kittn</span>
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
|
||||
<span class="n">api</span> <span class="o">=</span> <span class="n">kittn</span><span class="o">.</span><span class="n">authorize</span><span class="p">(</span><span class="s">'meowmeowmeow'</span><span class="p">)</span>
|
||||
</code></pre><pre class="highlight shell tab-shell"><code><span class="c"># With shell, you can just pass the correct header with each request</span>
|
||||
curl <span class="s2">"api_endpoint_here"</span>
|
||||
-H <span class="s2">"Authorization: meowmeowmeow"</span>
|
||||
</code></pre><pre class="highlight javascript tab-javascript"><code><span class="kr">const</span> <span class="nx">kittn</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'kittn'</span><span class="p">);</span>
|
||||
|
||||
<span class="kd">let</span> <span class="nx">api</span> <span class="o">=</span> <span class="nx">kittn</span><span class="p">.</span><span class="nx">authorize</span><span class="p">(</span><span class="s1">'meowmeowmeow'</span><span class="p">);</span>
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>Make sure to replace <code>meowmeowmeow</code> with your API key.</p>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success, see types"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"neko_list"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"types"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="s2">"..."</span><span class="w"> </span><span class="p">]</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre><h3 id='neko_list-nekos'><code>neko_list</code> | Nekos</h3>
|
||||
<p>List of available <code>neko</code> endpoints.</p>
|
||||
|
||||
<p>Kittn uses API keys to allow access to the API. You can register a new Kittn API key at our <a href="http://example.com/developers">developer portal</a>.</p>
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
|
||||
<p>Kittn expects for the API key to be included in all API requests to the server in a header that looks like the following:</p>
|
||||
|
||||
<p><code>Authorization: meowmeowmeow</code></p>
|
||||
|
||||
<aside class="notice">
|
||||
You must replace <code>meowmeowmeow</code> with your personal API key.
|
||||
</aside>
|
||||
<h1 id='kittens'>Kittens</h1><h2 id='get-all-kittens'>Get All Kittens</h2><pre class="highlight ruby tab-ruby"><code><span class="nb">require</span> <span class="s1">'kittn'</span>
|
||||
|
||||
<span class="n">api</span> <span class="o">=</span> <span class="no">Kittn</span><span class="o">::</span><span class="no">APIClient</span><span class="p">.</span><span class="nf">authorize!</span><span class="p">(</span><span class="s1">'meowmeowmeow'</span><span class="p">)</span>
|
||||
<span class="n">api</span><span class="p">.</span><span class="nf">kittens</span><span class="p">.</span><span class="nf">get</span>
|
||||
</code></pre><pre class="highlight python tab-python"><code><span class="kn">import</span> <span class="nn">kittn</span>
|
||||
|
||||
<span class="n">api</span> <span class="o">=</span> <span class="n">kittn</span><span class="o">.</span><span class="n">authorize</span><span class="p">(</span><span class="s">'meowmeowmeow'</span><span class="p">)</span>
|
||||
<span class="n">api</span><span class="o">.</span><span class="n">kittens</span><span class="o">.</span><span class="n">get</span><span class="p">()</span>
|
||||
</code></pre><pre class="highlight shell tab-shell"><code>curl <span class="s2">"http://example.com/api/kittens"</span>
|
||||
-H <span class="s2">"Authorization: meowmeowmeow"</span>
|
||||
</code></pre><pre class="highlight javascript tab-javascript"><code><span class="kr">const</span> <span class="nx">kittn</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'kittn'</span><span class="p">);</span>
|
||||
|
||||
<span class="kd">let</span> <span class="nx">api</span> <span class="o">=</span> <span class="nx">kittn</span><span class="p">.</span><span class="nx">authorize</span><span class="p">(</span><span class="s1">'meowmeowmeow'</span><span class="p">);</span>
|
||||
<span class="kd">let</span> <span class="nx">kittens</span> <span class="o">=</span> <span class="nx">api</span><span class="p">.</span><span class="nx">kittens</span><span class="p">.</span><span class="nx">get</span><span class="p">();</span>
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The above command returns JSON structured like this:</p>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="p">[</span><span class="w">
|
||||
</span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Fluffums"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"breed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"calico"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"fluffiness"</span><span class="p">:</span><span class="w"> </span><span class="mi">6</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"cuteness"</span><span class="p">:</span><span class="w"> </span><span class="mi">7</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Max"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"breed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"unknown"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"fluffiness"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"cuteness"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="w">
|
||||
<pre class="highlight json tab-json"><code><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">404</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ICe API in development, see later"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ice_response"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{}</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre><h3 id='ice_response-ice'><code>ice_response</code> | Ice</h3>
|
||||
<p>A generic bot response.</p>
|
||||
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
|
||||
<blockquote>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ice_http_code_response"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"http"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"standart"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"OK"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"description"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action."</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"choices"</span><span class="p">:</span><span class="w"> </span><span class="p">[]</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="s2">"source"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Wikipedia"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre><h3 id='ice_http_code_response-http'><code>ice_http_code_response</code> | Http</h3>
|
||||
<p>A response containing information about given http code.</p>
|
||||
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
|
||||
<blockquote>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">400</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Missing parameter code. Use it as /http/:code"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"e_ice_http_missing_code"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre><h3 id='ice_http_code_list-ice'><code>ice_http_code_list</code> | Ice</h3>
|
||||
<p>A <em>planned</em> response to list all available HTTP codes.</p>
|
||||
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
<h3 id='pushr_response-pushr'><code>pushr_response</code> | Pushr</h3>
|
||||
<p>A response from Pushr API (danbulant.eu API acts as pass-through for this).</p>
|
||||
|
||||
<blockquote>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success, see reddit"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"reddit_response"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"reddit"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"title"</span><span class="p">:</span><span class="w"> </span><span class="s2">"I really ininterested"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"image"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://imgur.com/tLBzS1h.jpg"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"author"</span><span class="p">:</span><span class="w"> </span><span class="s2">"nickjayr"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"authorIcon"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://www.redditstatic.com/avatars/avatar_default_17_0DD3BB.png"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"link"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://reddit.com/r/memes/comments/ey2hkb/i_really_ininterested/"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">]</span><span class="w">
|
||||
</span></code></pre>
|
||||
<p>This endpoint retrieves all kittens.</p>
|
||||
<h3 id='http-request'>HTTP Request</h3>
|
||||
<p><code>GET http://example.com/api/kittens</code></p>
|
||||
<h3 id='query-parameters'>Query Parameters</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Default</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>include_cats</td>
|
||||
<td>false</td>
|
||||
<td>If set to true, the result will also include cats.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>available</td>
|
||||
<td>true</td>
|
||||
<td>If set to false, the result will include kittens that have already been adopted.</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre><h3 id='redddit_response-reddit'><code>redddit_response</code> | Reddit</h3>
|
||||
<p>Response from reddit API containing <code>reddit</code> object.</p>
|
||||
|
||||
<aside class="success">
|
||||
Remember — a happy kitten is an authenticated kitten!
|
||||
</aside>
|
||||
<h2 id='get-a-specific-kitten'>Get a Specific Kitten</h2><pre class="highlight ruby tab-ruby"><code><span class="nb">require</span> <span class="s1">'kittn'</span>
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
|
||||
<span class="n">api</span> <span class="o">=</span> <span class="no">Kittn</span><span class="o">::</span><span class="no">APIClient</span><span class="p">.</span><span class="nf">authorize!</span><span class="p">(</span><span class="s1">'meowmeowmeow'</span><span class="p">)</span>
|
||||
<span class="n">api</span><span class="p">.</span><span class="nf">kittens</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
|
||||
</code></pre><pre class="highlight python tab-python"><code><span class="kn">import</span> <span class="nn">kittn</span>
|
||||
|
||||
<span class="n">api</span> <span class="o">=</span> <span class="n">kittn</span><span class="o">.</span><span class="n">authorize</span><span class="p">(</span><span class="s">'meowmeowmeow'</span><span class="p">)</span>
|
||||
<span class="n">api</span><span class="o">.</span><span class="n">kittens</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
|
||||
</code></pre><pre class="highlight shell tab-shell"><code>curl <span class="s2">"http://example.com/api/kittens/2"</span>
|
||||
-H <span class="s2">"Authorization: meowmeowmeow"</span>
|
||||
</code></pre><pre class="highlight javascript tab-javascript"><code><span class="kr">const</span> <span class="nx">kittn</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'kittn'</span><span class="p">);</span>
|
||||
|
||||
<span class="kd">let</span> <span class="nx">api</span> <span class="o">=</span> <span class="nx">kittn</span><span class="p">.</span><span class="nx">authorize</span><span class="p">(</span><span class="s1">'meowmeowmeow'</span><span class="p">);</span>
|
||||
<span class="kd">let</span> <span class="nx">max</span> <span class="o">=</span> <span class="nx">api</span><span class="p">.</span><span class="nx">kittens</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="mi">2</span><span class="p">);</span>
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The above command returns JSON structured like this:</p>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Max"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"breed"</span><span class="p">:</span><span class="w"> </span><span class="s2">"unknown"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"fluffiness"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"cuteness"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success, see response"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"path"</span><span class="p">:</span><span class="w"> </span><span class="s2">"/"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ester_response"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Čau!"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"user"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Daniel"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1"</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="s2">"text"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Čau!"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre>
|
||||
<p>This endpoint retrieves a specific kitten.</p>
|
||||
</span></code></pre><h3 id='ester_response-ester'><code>ester_response</code> | Ester</h3>
|
||||
<p>A generic response from Ester API.</p>
|
||||
|
||||
<aside class="warning">Inside HTML code blocks like this one, you can't use Markdown, so use <code><code></code> blocks to denote code.</aside>
|
||||
<h3 id='http-request-2'>HTTP Request</h3>
|
||||
<p><code>GET http://example.com/kittens/<ID></code></p>
|
||||
<h3 id='url-parameters'>URL Parameters</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>ID</td>
|
||||
<td>The ID of the kitten to retrieve</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h2 id='delete-a-specific-kitten'>Delete a Specific Kitten</h2><pre class="highlight ruby tab-ruby"><code><span class="nb">require</span> <span class="s1">'kittn'</span>
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
|
||||
<span class="n">api</span> <span class="o">=</span> <span class="no">Kittn</span><span class="o">::</span><span class="no">APIClient</span><span class="p">.</span><span class="nf">authorize!</span><span class="p">(</span><span class="s1">'meowmeowmeow'</span><span class="p">)</span>
|
||||
<span class="n">api</span><span class="p">.</span><span class="nf">kittens</span><span class="p">.</span><span class="nf">delete</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
|
||||
</code></pre><pre class="highlight python tab-python"><code><span class="kn">import</span> <span class="nn">kittn</span>
|
||||
|
||||
<span class="n">api</span> <span class="o">=</span> <span class="n">kittn</span><span class="o">.</span><span class="n">authorize</span><span class="p">(</span><span class="s">'meowmeowmeow'</span><span class="p">)</span>
|
||||
<span class="n">api</span><span class="o">.</span><span class="n">kittens</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
|
||||
</code></pre><pre class="highlight shell tab-shell"><code>curl <span class="s2">"http://example.com/api/kittens/2"</span>
|
||||
-X DELETE
|
||||
-H <span class="s2">"Authorization: meowmeowmeow"</span>
|
||||
</code></pre><pre class="highlight javascript tab-javascript"><code><span class="kr">const</span> <span class="nx">kittn</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">'kittn'</span><span class="p">);</span>
|
||||
|
||||
<span class="kd">let</span> <span class="nx">api</span> <span class="o">=</span> <span class="nx">kittn</span><span class="p">.</span><span class="nx">authorize</span><span class="p">(</span><span class="s1">'meowmeowmeow'</span><span class="p">);</span>
|
||||
<span class="kd">let</span> <span class="nx">max</span> <span class="o">=</span> <span class="nx">api</span><span class="p">.</span><span class="nx">kittens</span><span class="p">.</span><span class="k">delete</span><span class="p">(</span><span class="mi">2</span><span class="p">);</span>
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The above command returns JSON structured like this:</p>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"id"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"deleted"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">":("</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bakalari_response"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"verze"</span><span class="p">:</span><span class="w"> </span><span class="s2">"17/18.20191219"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"jmeno"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[NAME HIDDEN]"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"typ"</span><span class="p">:</span><span class="w"> </span><span class="s2">"R"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"strtyp"</span><span class="p">:</span><span class="w"> </span><span class="s2">"rodič"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"skola"</span><span class="p">:</span><span class="w"> </span><span class="s2">"[SCHOOL REDACTED]"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"typskoly"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"trida"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.A"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"rocnik"</span><span class="p">:</span><span class="w"> </span><span class="mi">-1</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"moduly"</span><span class="p">:</span><span class="w"> </span><span class="s2">"*znamky*predvidac*rozvrh*predmety*vyuka*ukoly*akce*suplovani*absence*pololetni*prijate*odeslane*nastenka*setread*setok*komsend*komenslisty*komdel*"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"params"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"newmarkdays"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="w">
|
||||
</span><span class="p">},</span><span class="w">
|
||||
</span><span class="s2">"result"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre>
|
||||
<p>This endpoint deletes a specific kitten.</p>
|
||||
<h3 id='http-request-3'>HTTP Request</h3>
|
||||
<p><code>DELETE http://example.com/kittens/<ID></code></p>
|
||||
<h3 id='url-parameters-2'>URL Parameters</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>ID</td>
|
||||
<td>The ID of the kitten to delete</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h1 id='errors'>Errors</h1>
|
||||
<aside class="notice">
|
||||
This error section is stored in a separate file in <code>includes/_errors.md</code>. Slate allows you to optionally separate out your docs into many files...just save them to the <code>includes</code> folder and add them to the top of your <code>index.md</code>'s frontmatter. Files are included in the order listed.
|
||||
</aside>
|
||||
</span></code></pre><h3 id='bakalari_response-bakalari'><code>bakalari_response</code> | Bakalari</h3>
|
||||
<p>Response from the <code>bakalari</code> API. Format depends on the bakalari response (e.g., try the desired info in browser to see, as danbulant.eu only converts xml to json).</p>
|
||||
|
||||
<p>The Kittn API uses the following error codes:</p>
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Error Code</th>
|
||||
<th>Meaning</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>400</td>
|
||||
<td>Bad Request -- Your request is invalid.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>401</td>
|
||||
<td>Unauthorized -- Your API key is wrong.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>403</td>
|
||||
<td>Forbidden -- The kitten requested is hidden for administrators only.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>404</td>
|
||||
<td>Not Found -- The specified kitten could not be found.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>405</td>
|
||||
<td>Method Not Allowed -- You tried to access a kitten with an invalid method.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>406</td>
|
||||
<td>Not Acceptable -- You requested a format that isn't json.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>410</td>
|
||||
<td>Gone -- The kitten requested has been removed from our servers.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>418</td>
|
||||
<td>I'm a teapot.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>429</td>
|
||||
<td>Too Many Requests -- You're requesting too many kittens! Slow down!</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>500</td>
|
||||
<td>Internal Server Error -- We had a problem with our server. Try again later.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>503</td>
|
||||
<td>Service Unavailable -- We're temporarily offline for maintenance. Please try again later.</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<blockquote>
|
||||
<p>Example response:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"code"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Success, see url"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"image"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"url"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://i.imgur.com/wVUpmao.jpg"</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre><h3 id='image'><code>image</code> | *</h3>
|
||||
<p>Generic image response. The actual image is on adress inside the provided <code>url</code> field.</p>
|
||||
|
||||
<p><br>
|
||||
<br>
|
||||
<br>
|
||||
<br>
|
||||
<br></p>
|
||||
<h1 id='libraries'>Libraries</h1><h2 id='js'>JS</h2>
|
||||
<p><em>Currently unavailable, but planned.</em>
|
||||
This library simplifies usage. It uses <code>got</code> under the hood for simplified request handling, and always returns promise.
|
||||
Responses are just parsed JSON (as of now, but classes may be implemented in future).</p>
|
||||
<h1 id='endpoints'>Endpoints</h1><h2 id='bakalari'>Bakalari</h2>
|
||||
<blockquote>
|
||||
<p>Example request</p>
|
||||
</blockquote>
|
||||
<pre class="highlight shell tab-shell"><code>curl <span class="s2">"https://api.danbulant.eu/v1/bakalari/rozvrh/user/domain.tld/SecretPassword123"</span>
|
||||
</code></pre>
|
||||
<p>Tries getting the info from Bakalari API.</p>
|
||||
|
||||
</div>
|
||||
<div class="dark-box">
|
||||
<div class="lang-selector">
|
||||
<a href="#" data-language-name="shell">shell</a>
|
||||
<a href="#" data-language-name="ruby">ruby</a>
|
||||
<a href="#" data-language-name="python">python</a>
|
||||
<a href="#" data-language-name="javascript">javascript</a>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
131
javascripts/all-c5541673.js
Normal file
131
javascripts/all-c5541673.js
Normal file
File diff suppressed because one or more lines are too long
31
javascripts/all_nosearch-c275c2f6.js
Normal file
31
javascripts/all_nosearch-c275c2f6.js
Normal file
File diff suppressed because one or more lines are too long
1
stylesheets/print-bccf8c07.css
Normal file
1
stylesheets/print-bccf8c07.css
Normal file
|
|
@ -0,0 +1 @@
|
|||
/*! normalize.css v3.0.2 | MIT License | git.io/normalize */html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}dfn{font-style:italic}h1{font-size:2em;margin:0.67em 0}mark{background:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{-webkit-box-sizing:content-box;box-sizing:content-box;height:0}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace, monospace;font-size:1em}button,input,optgroup,select,textarea{color:inherit;font:inherit;margin:0}button{overflow:visible}button,select{text-transform:none}button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}input{line-height:normal}input[type="checkbox"],input[type="radio"]{-webkit-box-sizing:border-box;box-sizing:border-box;padding:0}input[type="number"]::-webkit-inner-spin-button,input[type="number"]::-webkit-outer-spin-button{height:auto}input[type="search"]{-webkit-appearance:textfield;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}fieldset{border:1px solid #c0c0c0;margin:0 2px;padding:0.35em 0.625em 0.75em}legend{border:0;padding:0}textarea{overflow:auto}optgroup{font-weight:bold}table{border-collapse:collapse;border-spacing:0}td,th{padding:0}.content h1,.content h2,.content h3,.content h4,body{font-family:-apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";font-size:14px}.content h1,.content h2,.content h3,.content h4{font-weight:bold}.content pre,.content code{font-family:Consolas, Menlo, Monaco, "Lucida Console", "Liberation Mono", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Courier New", monospace, serif;font-size:12px;line-height:1.5}.content pre,.content code{word-break:break-all;-webkit-hyphens:auto;-ms-hyphens:auto;hyphens:auto}@font-face{font-family:'slate';src:url(../fonts/slate-cfc9d06b.eot?-syv14m);src:url(../fonts/slate-cfc9d06b.eot?#iefix-syv14m) format("embedded-opentype"),url(../fonts/slate-ddd488db.woff2?-syv14m) format("woff2"),url(../fonts/slate-33847ce5.woff?-syv14m) format("woff"),url(../fonts/slate-7b7da4fe.ttf?-syv14m) format("truetype"),url(../fonts/slate-e55b8307.svg?-syv14m#slate) format("svg");font-weight:normal;font-style:normal}.content aside.warning:before,.content aside.notice:before,.content aside.success:before{font-family:'slate';speak:none;font-style:normal;font-weight:normal;font-variant:normal;text-transform:none;line-height:1}.content aside.warning:before{content:"\e600"}.content aside.notice:before{content:"\e602"}.content aside.success:before{content:"\e606"}.tocify,.toc-footer,.lang-selector,.search,#nav-button{display:none}.tocify-wrapper>img{margin:0 auto;display:block}.content{font-size:12px}.content pre,.content code{border:1px solid #999;border-radius:5px;font-size:0.8em}.content pre code{border:0}.content pre{padding:1.3em}.content code{padding:0.2em}.content table{border:1px solid #999}.content table tr{border-bottom:1px solid #999}.content table td,.content table th{padding:0.7em}.content p{line-height:1.5}.content a{text-decoration:none;color:#000}.content h1{font-size:2.5em;padding-top:0.5em;padding-bottom:0.5em;margin-top:1em;margin-bottom:21px;border:2px solid #ccc;border-width:2px 0;text-align:center}.content h2{font-size:1.8em;margin-top:2em;border-top:2px solid #ccc;padding-top:0.8em}.content h1+h2,.content h1+div+h2{border-top:none;padding-top:0;margin-top:0}.content h3,.content h4{font-size:0.8em;margin-top:1.5em;margin-bottom:0.8em;text-transform:uppercase}.content h5,.content h6{text-transform:uppercase}.content aside{padding:1em;border:1px solid #ccc;border-radius:5px;margin-top:1.5em;margin-bottom:1.5em;line-height:1.6}.content aside:before{vertical-align:middle;padding-right:0.5em;font-size:14px}
|
||||
1
stylesheets/screen-a1ce949a.css
Normal file
1
stylesheets/screen-a1ce949a.css
Normal file
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue