mirror of
https://github.com/ACINQ/eclair.git
synced 2025-02-24 14:50:46 +01:00
Initial version of the new API docs
This commit is contained in:
Andrea
parent
caa056eaf3
commit
8e4706abc6
24 changed files with 1494 additions and 0 deletions
BIN
public/build/fonts/slate.eot
Normal file
BIN
public/build/fonts/slate.eot
Normal file
Binary file not shown.
14
public/build/fonts/slate.svg
Normal file
14
public/build/fonts/slate.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
public/build/fonts/slate.ttf
Normal file
BIN
public/build/fonts/slate.ttf
Normal file
Binary file not shown.
BIN
public/build/fonts/slate.woff
Normal file
BIN
public/build/fonts/slate.woff
Normal file
Binary file not shown.
BIN
public/build/fonts/slate.woff2
Normal file
BIN
public/build/fonts/slate.woff2
Normal file
Binary file not shown.
BIN
public/build/images/logo.png
Normal file
BIN
public/build/images/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
BIN
public/build/images/navbar.png
Normal file
BIN
public/build/images/navbar.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 96 B |
633
public/build/index.html
Normal file
633
public/build/index.html
Normal file
|
|
@ -0,0 +1,633 @@
|
|||
|
||||
<!doctype html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
|
||||
<title>Eclair API</title>
|
||||
|
||||
<style>
|
||||
.highlight table td { padding: 5px; }
|
||||
.highlight table pre { margin: 0; }
|
||||
.highlight .gh {
|
||||
color: #999999;
|
||||
}
|
||||
.highlight .sr {
|
||||
color: #f6aa11;
|
||||
}
|
||||
.highlight .go {
|
||||
color: #888888;
|
||||
}
|
||||
.highlight .gp {
|
||||
color: #555555;
|
||||
}
|
||||
.highlight .gs {
|
||||
}
|
||||
.highlight .gu {
|
||||
color: #aaaaaa;
|
||||
}
|
||||
.highlight .nb {
|
||||
color: #f6aa11;
|
||||
}
|
||||
.highlight .cm {
|
||||
color: #75715e;
|
||||
}
|
||||
.highlight .cp {
|
||||
color: #75715e;
|
||||
}
|
||||
.highlight .c1 {
|
||||
color: #75715e;
|
||||
}
|
||||
.highlight .cs {
|
||||
color: #75715e;
|
||||
}
|
||||
.highlight .c, .highlight .cd {
|
||||
color: #75715e;
|
||||
}
|
||||
.highlight .err {
|
||||
color: #960050;
|
||||
}
|
||||
.highlight .gr {
|
||||
color: #960050;
|
||||
}
|
||||
.highlight .gt {
|
||||
color: #960050;
|
||||
}
|
||||
.highlight .gd {
|
||||
color: #49483e;
|
||||
}
|
||||
.highlight .gi {
|
||||
color: #49483e;
|
||||
}
|
||||
.highlight .ge {
|
||||
color: #49483e;
|
||||
}
|
||||
.highlight .kc {
|
||||
color: #66d9ef;
|
||||
}
|
||||
.highlight .kd {
|
||||
color: #66d9ef;
|
||||
}
|
||||
.highlight .kr {
|
||||
color: #66d9ef;
|
||||
}
|
||||
.highlight .no {
|
||||
color: #66d9ef;
|
||||
}
|
||||
.highlight .kt {
|
||||
color: #66d9ef;
|
||||
}
|
||||
.highlight .mf {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .mh {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .il {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .mi {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .mo {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .m, .highlight .mb, .highlight .mx {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .sc {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .se {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .ss {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .sd {
|
||||
color: #e6db74;
|
||||
}
|
||||
.highlight .s2 {
|
||||
color: #e6db74;
|
||||
}
|
||||
.highlight .sb {
|
||||
color: #e6db74;
|
||||
}
|
||||
.highlight .sh {
|
||||
color: #e6db74;
|
||||
}
|
||||
.highlight .si {
|
||||
color: #e6db74;
|
||||
}
|
||||
.highlight .sx {
|
||||
color: #e6db74;
|
||||
}
|
||||
.highlight .s1 {
|
||||
color: #e6db74;
|
||||
}
|
||||
.highlight .s {
|
||||
color: #e6db74;
|
||||
}
|
||||
.highlight .na {
|
||||
color: #a6e22e;
|
||||
}
|
||||
.highlight .nc {
|
||||
color: #a6e22e;
|
||||
}
|
||||
.highlight .nd {
|
||||
color: #a6e22e;
|
||||
}
|
||||
.highlight .ne {
|
||||
color: #a6e22e;
|
||||
}
|
||||
.highlight .nf {
|
||||
color: #a6e22e;
|
||||
}
|
||||
.highlight .vc {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .nn {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .nl {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .ni {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .bp {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .vg {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .vi {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .nv {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .w {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .n, .highlight .py, .highlight .nx {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .ow {
|
||||
color: #f92672;
|
||||
}
|
||||
.highlight .nt {
|
||||
color: #f92672;
|
||||
}
|
||||
.highlight .k, .highlight .kv {
|
||||
color: #f92672;
|
||||
}
|
||||
.highlight .kn {
|
||||
color: #f92672;
|
||||
}
|
||||
.highlight .kp {
|
||||
color: #f92672;
|
||||
}
|
||||
.highlight .o {
|
||||
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>
|
||||
</head>
|
||||
|
||||
<body class="index" data-languages="["shell"]">
|
||||
<a href="#" id="nav-button">
|
||||
<span>
|
||||
NAV
|
||||
<img src="images/navbar.png" alt="Navbar" />
|
||||
</span>
|
||||
</a>
|
||||
<div class="toc-wrapper">
|
||||
<img src="images/logo.png" class="logo" alt="Logo" />
|
||||
<div class="lang-selector">
|
||||
<a href="#" data-language-name="shell">shell</a>
|
||||
</div>
|
||||
<div class="search">
|
||||
<input type="text" class="search" id="input-search" placeholder="Search">
|
||||
</div>
|
||||
<ul class="search-results"></ul>
|
||||
<ul id="toc" class="toc-list-h1">
|
||||
<li>
|
||||
<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="#getinfo" class="toc-h1 toc-link" data-title="GetInfo">GetInfo</a>
|
||||
<ul class="toc-list-h2">
|
||||
<li>
|
||||
<a href="#getinfo-2" class="toc-h2 toc-link" data-title="GetInfo">GetInfo</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#connect" class="toc-h1 toc-link" data-title="Connect">Connect</a>
|
||||
<ul class="toc-list-h2">
|
||||
<li>
|
||||
<a href="#connect-via-uri" class="toc-h2 toc-link" data-title="Connect via URI">Connect via URI</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#connect-manually" class="toc-h2 toc-link" data-title="Connect manually">Connect manually</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#open" class="toc-h1 toc-link" data-title="Open">Open</a>
|
||||
<ul class="toc-list-h2">
|
||||
<li>
|
||||
<a href="#open-2" class="toc-h2 toc-link" data-title="Open">Open</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#close" class="toc-h1 toc-link" data-title="Close">Close</a>
|
||||
<ul class="toc-list-h2">
|
||||
<li>
|
||||
<a href="#close-2" class="toc-h2 toc-link" data-title="Close">Close</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#force-close" class="toc-h2 toc-link" data-title="Force Close">Force Close</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#updaterelayfee" class="toc-h1 toc-link" data-title="UpdateRelayFee">UpdateRelayFee</a>
|
||||
<ul class="toc-list-h2">
|
||||
<li>
|
||||
<a href="#updaterelayfee-2" class="toc-h2 toc-link" data-title="updaterelayfee">updaterelayfee</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#peers" class="toc-h1 toc-link" data-title="Peers">Peers</a>
|
||||
<ul class="toc-list-h2">
|
||||
<li>
|
||||
<a href="#peers-2" class="toc-h2 toc-link" data-title="peers">peers</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#channels" class="toc-h1 toc-link" data-title="Channels">Channels</a>
|
||||
<ul class="toc-list-h2">
|
||||
<li>
|
||||
<a href="#channels-2" class="toc-h2 toc-link" data-title="channels">channels</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#errors" class="toc-h1 toc-link" data-title="Errors">Errors</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="toc-footer">
|
||||
<li><a href='https://github.com/lord/slate'>Documentation Powered by Slate</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 Eclair API, this website contains documentation and code examples about how to interact with the Eclair lightning node via its API.
|
||||
Feel free to suggest improvements and fixes to this documentation by submitting a pull request to the <a href="https://github.com/ACINQ/eclair">repo</a>. The API
|
||||
uses http form data to receive parameteres from the clients, please refer to RFC LINK HERE </p>
|
||||
<h1 id='authentication'>Authentication</h1>
|
||||
<p>Eclair uses HTTP Basic authentication and expects to receive the correct header with every request. Please note that eclair only expects a password and an
|
||||
empty user name. </p>
|
||||
|
||||
<p><code>Authorization: <Base64EncodedCredentials></code></p>
|
||||
<h1 id='getinfo'>GetInfo</h1><h2 id='getinfo-2'>GetInfo</h2><pre class="highlight shell tab-shell"><code>curl <span class="s2">"http://example.com/getinfo"</span> -H <span class="s2">"Authorization: meowmeowmeow"</span>
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The above command returns JSON structured like this:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight json tab-json"><code><span class="p">{</span><span class="w">
|
||||
</span><span class="s2">"nodeId"</span><span class="p">:</span><span class="s2">"03864ef025fde8fb587d989186ce6a4a186895ee44a926bfc370e2c366597a3f8f"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"alias"</span><span class="p">:</span><span class="s2">"ACINQ"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"chainHash"</span><span class="p">:</span><span class="s2">"06226e46111a0b59caaf126043eb5bbf28c34f3a5e332a1fc7b2b73cf188910f"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"blockHeight"</span><span class="p">:</span><span class="mi">123456</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"publicAddresses"</span><span class="p">:[</span><span class="w">
|
||||
</span><span class="s2">"34.239.230.56:9735"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"of7husrflx7sforh3fw6yqlpwstee3wg5imvvmkp4bz6rbjxtg5nljad.onion:9735"</span><span class="w">
|
||||
</span><span class="p">]</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre>
|
||||
<p>Returns information about this instance such as <strong>nodeId</strong> and current block height as seen by eclair.</p>
|
||||
<h3 id='http-request'>HTTP Request</h3>
|
||||
<p><code>POST http://example.com/getinfo</code></p>
|
||||
<h1 id='connect'>Connect</h1><h2 id='connect-via-uri'>Connect via URI</h2><pre class="highlight shell tab-shell"><code>curl -F <span class="nv">uri</span><span class="o">=</span><target_uri> <span class="s2">"http://example.com/connect"</span> -H <span class="s2">"Authorization: meowmeowmeow"</span>
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The above command returns:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight plaintext"><code>connected
|
||||
</code></pre>
|
||||
<p>Connect to another lightning node, this will perform a connection but no channel will be opened.</p>
|
||||
<h3 id='http-request-2'>HTTP Request</h3>
|
||||
<p><code>POST http://example.com/connect</code></p>
|
||||
<h3 id='parameters'>Parameters</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>uri</td>
|
||||
<td>The URI in format 'nodeId@host:port'</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h2 id='connect-manually'>Connect manually</h2><pre class="highlight shell tab-shell"><code>curl -F <span class="nv">nodeId</span><span class="o">=</span><node_id> -F <span class="nv">host</span><span class="o">=</span>1.2.3.4 -F <span class="nv">port</span><span class="o">=</span>1234 <span class="s2">"http://example.com/connect"</span> -H <span class="s2">"Authorization: meowmeowmeow"</span>
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The above command returns:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight plaintext"><code>connected
|
||||
</code></pre>
|
||||
<p>Connect to another lightning node, this will perform a connection but no channel will be opened.</p>
|
||||
<h3 id='http-request-3'>HTTP Request</h3>
|
||||
<p><code>POST http://example.com/connect</code></p>
|
||||
<h3 id='parameters-2'>Parameters</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>nodeId</td>
|
||||
<td>The nodeId of the node you want to connect to</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>host</td>
|
||||
<td>The IPv4 host address of the node</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>port</td>
|
||||
<td>The port of the node</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h1 id='open'>Open</h1><h2 id='open-2'>Open</h2><pre class="highlight shell tab-shell"><code>curl -F <span class="nv">nodeId</span><span class="o">=</span>03864ef025fde8fb587d989186ce6a4a186895ee44a926bfc370e2c366597a3f8f
|
||||
-F <span class="nv">fundingSatoshis</span><span class="o">=</span>1234 <span class="s2">"http://example.com/open"</span> -H <span class="s2">"Authorization: meowmeowmeow"</span>
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The above command returns the channelId of the newly created channel:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight plaintext"><code>e872f515dc5d8a3d61ccbd2127f33141eaa115807271dcc5c5c727f3eca914d3
|
||||
</code></pre>
|
||||
<p>Open a channel to another lightning node, you must specify the target nodeId and the funding satoshis for the new channel. Optionally
|
||||
you can send to the remote a 'pushMsat' value and you can specify wether this should be a public or private channel (default is set in the config).</p>
|
||||
<h3 id='http-request-4'>HTTP Request</h3>
|
||||
<p><code>POST http://example.com/open</code></p>
|
||||
<h3 id='parameters-3'>Parameters</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>nodeId</td>
|
||||
<td>The nodeId of the node you want to connect to</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>fundingSatoshis</td>
|
||||
<td>Amount of satoshis to spend in the funding of the channel</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>pushMsat</td>
|
||||
<td>Amount of millisatoshi to unilaterally push to the counterparty (optional)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>fundingFeerateSatByte</td>
|
||||
<td>Feerate in sat/byte to apply to the funding transaction (optional)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>channelFlags</td>
|
||||
<td>Flags for the new channel: 0 = private, 1 = public (optional)</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h1 id='close'>Close</h1><h2 id='close-2'>Close</h2><pre class="highlight shell tab-shell"><code>curl -F <span class="nv">channelId</span><span class="o">=</span>03864ef025fde8fb587d989186ce6a4a186895ee44a926bfc370e2c366597a3f8f <span class="s2">"http://example.com/close"</span> -H <span class="s2">"Authorization: meowmeowmeow"</span>
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The above command returns:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight plaintext"><code>ok
|
||||
</code></pre>
|
||||
<p>Initiates a cooperative close for a give channel that belongs to this eclair node, the API returns once the funding_signed message has been negotiated.
|
||||
If you specified a scriptPubKey then the closing transaction will spend to that address. Note that you must specify at least a 'channelId' or 'shortChannelId'.</p>
|
||||
<h3 id='http-request-5'>HTTP Request</h3>
|
||||
<p><code>POST http://example.com/close</code></p>
|
||||
<h3 id='parameters-4'>Parameters</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>channelId</td>
|
||||
<td>The channelId of the channel you want to close</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>shortChannelId</td>
|
||||
<td>The shortChannelId of the channel you want to close (optional)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>scriptPubKey</td>
|
||||
<td>A serialized scriptPubKey that you want to use to close the channel (optional)</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h2 id='force-close'>Force Close</h2><pre class="highlight shell tab-shell"><code>curl -F <span class="nv">channelId</span><span class="o">=</span>03864ef025fde8fb587d989186ce6a4a186895ee44a926bfc370e2c366597a3f8f <span class="s2">"http://example.com/forceclose"</span> -H <span class="s2">"Authorization: meowmeowmeow"</span>
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The above command returns:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight plaintext"><code>e872f515dc5d8a3d61ccbd2127f33141eaa115807271dcc5c5c727f3eca914d3
|
||||
</code></pre>
|
||||
<p>Initiates an unilateral close for a give channel that belongs to this eclair node, once the commitment has been broadcasted the API returns its
|
||||
transaction id. Note that you must specify at least a 'channelId' or 'shortChannelId'.</p>
|
||||
<h3 id='http-request-6'>HTTP Request</h3>
|
||||
<p><code>POST http://example.com/forceclose</code></p>
|
||||
<h3 id='parameters-5'>Parameters</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>channelId</td>
|
||||
<td>The channelId of the channel you want to close</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>shortChannelId</td>
|
||||
<td>The shortChannelId of the channel you want to close (optional)</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h1 id='updaterelayfee'>UpdateRelayFee</h1><h2 id='updaterelayfee-2'>updaterelayfee</h2><pre class="highlight shell tab-shell"><code>curl -F <span class="nv">channelId</span><span class="o">=</span>03864ef025fde8fb587d989186ce6a4a186895ee44a926bfc370e2c366597a3f8f
|
||||
-F <span class="nv">feeBaseMsat</span><span class="o">=</span>10 -F <span class="nv">feeProportionalMillionths</span><span class="o">=</span>5
|
||||
<span class="s2">"http://example.com/updaterelayfee"</span> -H <span class="s2">"Authorization: meowmeowmeow"</span>
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The above command returns:</p>
|
||||
</blockquote>
|
||||
<pre class="highlight plaintext"><code>ok
|
||||
</code></pre>
|
||||
<p>Updates the fee policy for the specified channelId, a new update for this channel will be broadcasted to the network.</p>
|
||||
<h3 id='http-request-7'>HTTP Request</h3>
|
||||
<p><code>POST http://example.com/updaterelayfee</code></p>
|
||||
<h3 id='parameters-6'>Parameters</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>channelId</td>
|
||||
<td>The channelId of the channel you want to update</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>feeBaseMsat</td>
|
||||
<td>The new base fee to use</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>feeProportionalMillionths</td>
|
||||
<td>The new proportional fee to use</td>
|
||||
</tr>
|
||||
</tbody></table>
|
||||
<h1 id='peers'>Peers</h1><h2 id='peers-2'>peers</h2><pre class="highlight shell tab-shell"><code>curl <span class="s2">"http://example.com/peers"</span> -H <span class="s2">"Authorization: meowmeowmeow"</span>
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The above command returns:</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">"nodeId"</span><span class="p">:</span><span class="s2">"03864ef025fde8fb587d989186ce6a4a186895ee44a926bfc370e2c366597a3f8f"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"state"</span><span class="p">:</span><span class="s2">"CONNECTED"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"address"</span><span class="p">:</span><span class="s2">"34.239.230.56:9735"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"channels"</span><span class="p">:</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><span class="s2">"nodeId"</span><span class="p">:</span><span class="s2">"039dc0e0b1d25905e44fdf6f8e89755a5e219685840d0bc1d28d3308f9628a3585"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"state"</span><span class="p">:</span><span class="s2">"DISCONNECTED"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"channels"</span><span class="p">:</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>Returns the list of currently known peers, both connected and disconnected.</p>
|
||||
<h3 id='http-request-8'>HTTP Request</h3>
|
||||
<p><code>POST http://example.com/peers</code></p>
|
||||
<h1 id='channels'>Channels</h1><h2 id='channels-2'>channels</h2><pre class="highlight shell tab-shell"><code>curl <span class="s2">"http://example.com/channels"</span> -H <span class="s2">"Authorization: meowmeowmeow"</span>
|
||||
</code></pre>
|
||||
<blockquote>
|
||||
<p>The above command returns:</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">"nodeId"</span><span class="p">:</span><span class="s2">"03864ef025fde8fb587d989186ce6a4a186895ee44a926bfc370e2c366597a3f8f"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"state"</span><span class="p">:</span><span class="s2">"CONNECTED"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"address"</span><span class="p">:</span><span class="s2">"34.239.230.56:9735"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"channels"</span><span class="p">:</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><span class="s2">"nodeId"</span><span class="p">:</span><span class="s2">"039dc0e0b1d25905e44fdf6f8e89755a5e219685840d0bc1d28d3308f9628a3585"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"state"</span><span class="p">:</span><span class="s2">"DISCONNECTED"</span><span class="p">,</span><span class="w">
|
||||
</span><span class="s2">"channels"</span><span class="p">:</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>Returns the list of local channels, optionally filtered by remote node. </p>
|
||||
<h3 id='http-request-9'>HTTP Request</h3>
|
||||
<p><code>POST http://example.com/channels</code></p>
|
||||
<h3 id='parameters-7'>Parameters</h3>
|
||||
<table><thead>
|
||||
<tr>
|
||||
<th>Parameter</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead><tbody>
|
||||
<tr>
|
||||
<td>toRemoteNodeId</td>
|
||||
<td>The remote node id to be used as filter for the channels</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>
|
||||
|
||||
<p>The Kittn API uses the following error codes:</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>
|
||||
|
||||
</div>
|
||||
<div class="dark-box">
|
||||
<div class="lang-selector">
|
||||
<a href="#" data-language-name="shell">shell</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
131
public/build/javascripts/all.js
Normal file
131
public/build/javascripts/all.js
Normal file
File diff suppressed because one or more lines are too long
31
public/build/javascripts/all_nosearch.js
Normal file
31
public/build/javascripts/all_nosearch.js
Normal file
File diff suppressed because one or more lines are too long
1
public/build/stylesheets/print.css
Normal file
1
public/build/stylesheets/print.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{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"]{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;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.eot?-syv14m);src:url(../fonts/slate.eot?#iefix-syv14m) format("embedded-opentype"),url(../fonts/slate.woff2?-syv14m) format("woff2"),url(../fonts/slate.woff?-syv14m) format("woff"),url(../fonts/slate.ttf?-syv14m) format("truetype"),url(../fonts/slate.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
public/build/stylesheets/screen.css
Normal file
1
public/build/stylesheets/screen.css
Normal file
File diff suppressed because one or more lines are too long
BIN
public/fonts/slate.eot
Normal file
BIN
public/fonts/slate.eot
Normal file
Binary file not shown.
14
public/fonts/slate.svg
Normal file
14
public/fonts/slate.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
public/fonts/slate.ttf
Normal file
BIN
public/fonts/slate.ttf
Normal file
Binary file not shown.
BIN
public/fonts/slate.woff
Normal file
BIN
public/fonts/slate.woff
Normal file
Binary file not shown.
BIN
public/fonts/slate.woff2
Normal file
BIN
public/fonts/slate.woff2
Normal file
Binary file not shown.
BIN
public/images/logo.png
Normal file
BIN
public/images/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
BIN
public/images/navbar.png
Normal file
BIN
public/images/navbar.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 96 B |
505
public/index.html
Normal file
505
public/index.html
Normal file
|
|
@ -0,0 +1,505 @@
|
|||
|
||||
<!doctype html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
|
||||
<title>API Reference</title>
|
||||
|
||||
<style>
|
||||
.highlight table td { padding: 5px; }
|
||||
.highlight table pre { margin: 0; }
|
||||
.highlight .gh {
|
||||
color: #999999;
|
||||
}
|
||||
.highlight .sr {
|
||||
color: #f6aa11;
|
||||
}
|
||||
.highlight .go {
|
||||
color: #888888;
|
||||
}
|
||||
.highlight .gp {
|
||||
color: #555555;
|
||||
}
|
||||
.highlight .gs {
|
||||
}
|
||||
.highlight .gu {
|
||||
color: #aaaaaa;
|
||||
}
|
||||
.highlight .nb {
|
||||
color: #f6aa11;
|
||||
}
|
||||
.highlight .cm {
|
||||
color: #75715e;
|
||||
}
|
||||
.highlight .cp {
|
||||
color: #75715e;
|
||||
}
|
||||
.highlight .c1 {
|
||||
color: #75715e;
|
||||
}
|
||||
.highlight .cs {
|
||||
color: #75715e;
|
||||
}
|
||||
.highlight .c, .highlight .cd {
|
||||
color: #75715e;
|
||||
}
|
||||
.highlight .err {
|
||||
color: #960050;
|
||||
}
|
||||
.highlight .gr {
|
||||
color: #960050;
|
||||
}
|
||||
.highlight .gt {
|
||||
color: #960050;
|
||||
}
|
||||
.highlight .gd {
|
||||
color: #49483e;
|
||||
}
|
||||
.highlight .gi {
|
||||
color: #49483e;
|
||||
}
|
||||
.highlight .ge {
|
||||
color: #49483e;
|
||||
}
|
||||
.highlight .kc {
|
||||
color: #66d9ef;
|
||||
}
|
||||
.highlight .kd {
|
||||
color: #66d9ef;
|
||||
}
|
||||
.highlight .kr {
|
||||
color: #66d9ef;
|
||||
}
|
||||
.highlight .no {
|
||||
color: #66d9ef;
|
||||
}
|
||||
.highlight .kt {
|
||||
color: #66d9ef;
|
||||
}
|
||||
.highlight .mf {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .mh {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .il {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .mi {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .mo {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .m, .highlight .mb, .highlight .mx {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .sc {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .se {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .ss {
|
||||
color: #ae81ff;
|
||||
}
|
||||
.highlight .sd {
|
||||
color: #e6db74;
|
||||
}
|
||||
.highlight .s2 {
|
||||
color: #e6db74;
|
||||
}
|
||||
.highlight .sb {
|
||||
color: #e6db74;
|
||||
}
|
||||
.highlight .sh {
|
||||
color: #e6db74;
|
||||
}
|
||||
.highlight .si {
|
||||
color: #e6db74;
|
||||
}
|
||||
.highlight .sx {
|
||||
color: #e6db74;
|
||||
}
|
||||
.highlight .s1 {
|
||||
color: #e6db74;
|
||||
}
|
||||
.highlight .s {
|
||||
color: #e6db74;
|
||||
}
|
||||
.highlight .na {
|
||||
color: #a6e22e;
|
||||
}
|
||||
.highlight .nc {
|
||||
color: #a6e22e;
|
||||
}
|
||||
.highlight .nd {
|
||||
color: #a6e22e;
|
||||
}
|
||||
.highlight .ne {
|
||||
color: #a6e22e;
|
||||
}
|
||||
.highlight .nf {
|
||||
color: #a6e22e;
|
||||
}
|
||||
.highlight .vc {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .nn {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .nl {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .ni {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .bp {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .vg {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .vi {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .nv {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .w {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .n, .highlight .py, .highlight .nx {
|
||||
color: #ffffff;
|
||||
}
|
||||
.highlight .ow {
|
||||
color: #f92672;
|
||||
}
|
||||
.highlight .nt {
|
||||
color: #f92672;
|
||||
}
|
||||
.highlight .k, .highlight .kv {
|
||||
color: #f92672;
|
||||
}
|
||||
.highlight .kn {
|
||||
color: #f92672;
|
||||
}
|
||||
.highlight .kp {
|
||||
color: #f92672;
|
||||
}
|
||||
.highlight .o {
|
||||
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>
|
||||
</head>
|
||||
|
||||
<body class="index" data-languages="["shell","ruby","python","javascript"]">
|
||||
<a href="#" id="nav-button">
|
||||
<span>
|
||||
NAV
|
||||
<img src="images/navbar.png" alt="Navbar" />
|
||||
</span>
|
||||
</a>
|
||||
<div class="toc-wrapper">
|
||||
<img src="images/logo.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">
|
||||
<input type="text" class="search" id="input-search" placeholder="Search">
|
||||
</div>
|
||||
<ul class="search-results"></ul>
|
||||
<ul id="toc" class="toc-list-h1">
|
||||
<li>
|
||||
<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>
|
||||
<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>
|
||||
</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>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#errors" class="toc-h1 toc-link" data-title="Errors">Errors</a>
|
||||
</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>
|
||||
</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>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>
|
||||
|
||||
<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>
|
||||
</blockquote>
|
||||
<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>
|
||||
</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>
|
||||
</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>
|
||||
</blockquote>
|
||||
|
||||
<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>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>
|
||||
</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">
|
||||
</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>
|
||||
|
||||
<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>
|
||||
|
||||
<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>
|
||||
</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="p">}</span><span class="w">
|
||||
</span></code></pre>
|
||||
<p>This endpoint retrieves a specific kitten.</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>
|
||||
|
||||
<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>
|
||||
</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="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>
|
||||
|
||||
<p>The Kittn API uses the following error codes:</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>
|
||||
|
||||
</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>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
131
public/javascripts/all.js
Normal file
131
public/javascripts/all.js
Normal file
File diff suppressed because one or more lines are too long
31
public/javascripts/all_nosearch.js
Normal file
31
public/javascripts/all_nosearch.js
Normal file
File diff suppressed because one or more lines are too long
1
public/stylesheets/print.css
Normal file
1
public/stylesheets/print.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{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"]{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;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.eot?-syv14m);src:url(../fonts/slate.eot?#iefix-syv14m) format("embedded-opentype"),url(../fonts/slate.woff2?-syv14m) format("woff2"),url(../fonts/slate.woff?-syv14m) format("woff"),url(../fonts/slate.ttf?-syv14m) format("truetype"),url(../fonts/slate.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
public/stylesheets/screen.css
Normal file
1
public/stylesheets/screen.css
Normal file
File diff suppressed because one or more lines are too long
Loading…
Add table
Reference in a new issue