mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-16 17:55:49 +00:00
template bugfixes - code expand, sidebar
This commit is contained in:
@@ -162,7 +162,7 @@
|
||||
.page-template-template-dev-portal-php .level-3 a:hover {
|
||||
color: #666;
|
||||
}
|
||||
.page-template-template-dev-portal-php ul#dev_nav_sidebar {
|
||||
.page-template-template-dev-portal-php .dev_nav_sidebar {
|
||||
padding-left: 5px;
|
||||
list-style-type: none;
|
||||
max-width: 370px;
|
||||
@@ -172,7 +172,6 @@
|
||||
width: 100%;
|
||||
overflow-y: scroll;
|
||||
top: 130px;
|
||||
bottom: 35px;
|
||||
}
|
||||
.page-template-template-dev-portal-php td {
|
||||
border: 1px solid #dbdde2;
|
||||
|
||||
@@ -5,10 +5,8 @@ var toggle_cs = function(eo) {
|
||||
code_el.toggleClass('expanded');
|
||||
var placeholders = wrapper.find(".code-placeholder");
|
||||
if (placeholders.length) {
|
||||
console.log("bye bye placeholders");
|
||||
placeholders.remove();
|
||||
} else {
|
||||
console.log("makin' a placeholder");
|
||||
code_el.after("<div class='code-placeholder' style='width:"
|
||||
+ code_el.width()
|
||||
+ "px; height:"
|
||||
@@ -32,6 +30,8 @@ function make_code_expandable() {
|
||||
var newbtn = $("<input type='button' class='code_toggler' value='Expand' />");
|
||||
newbtn.appendTo(cs);
|
||||
$(".code_toggler").click(toggle_cs);
|
||||
|
||||
/* fix expand/collapse and tab click hierarchy */
|
||||
cs.css("position","relative");
|
||||
$(".multicode .code_sample").css("position","static");
|
||||
}
|
||||
|
||||
$(document).on('flatdoc:ready', make_code_expandable);
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
$(window).scroll(function() {
|
||||
var footerpos = parseInt($(".footer").offset().top);
|
||||
var footerpos = parseInt($("footer").offset().top);
|
||||
var scrollpos = $(window).scrollTop() + $(window).height();
|
||||
if(scrollpos - footerpos > 0) {
|
||||
$(".menubar.fixed").css("margin-bottom", scrollpos-footerpos);
|
||||
$("aside.sidebar .dev_nav_wrapper").css("bottom", (scrollpos-footerpos)+"px");
|
||||
} else {
|
||||
$(".menubar.fixed").css("margin-bottom", 0);
|
||||
$("aside.sidebar .dev_nav_wrapper").css("bottom", 0);
|
||||
}
|
||||
});
|
||||
|
||||
@@ -1,38 +1,3 @@
|
||||
// Original code to adapt the markup for tabs.
|
||||
// Expects markup in the form of:
|
||||
// <div class='multicode'>
|
||||
// <em>tab 1 title</em>
|
||||
// <code>tab 1 code block</code>
|
||||
// <em>tab 2 title</em>
|
||||
// <code>tab 2 code block</code>
|
||||
// </div>
|
||||
jQuery.fn.multicode_tabs = function() {
|
||||
$('.multicode').each(function(index,el) {
|
||||
cb_area = $(el);
|
||||
cb_area.attr('id', "code-"+index);
|
||||
// make a ul to house the tab headers
|
||||
cb_area.prepend("<ul class='codetabs'></ul>");
|
||||
|
||||
// for each code, give it a unique ID and wrap it in a pre
|
||||
cb_area.children('code').each(function(index2,el2) {
|
||||
var linkid = 'code-'+index+'-'+index2;
|
||||
$(el2).wrap("<div id='"+linkid+"' class='code_sample'><pre>");
|
||||
//also put in a link to this in the tab header ul
|
||||
$('ul', cb_area).append("<li><a href='#"+linkid+"'></a></li>");
|
||||
});
|
||||
|
||||
//use the ems to fill in the tab headers for each block
|
||||
$(el).children('em').each(function(index2, el2) {
|
||||
$('ul li:eq('+index2+') a', cb_area).text($(el2).text());
|
||||
});
|
||||
});
|
||||
$('.multicode em').hide();
|
||||
|
||||
$('.multicode').minitabs();
|
||||
}
|
||||
|
||||
|
||||
// Variant version for the HTML that Pandoc generates
|
||||
// Expects markup in the form of:
|
||||
// <div class='multicode'>
|
||||
// <p><em>tab 1 title</em></p>
|
||||
@@ -40,7 +5,7 @@ jQuery.fn.multicode_tabs = function() {
|
||||
// <p><em>tab 2 title</em></p>
|
||||
// <pre><code>tab 2 code block</code></pre>
|
||||
// </div>
|
||||
jQuery.fn.multicode_tabs_pandoc = function() {
|
||||
jQuery.fn.multicode_tabs = function() {
|
||||
$('.multicode').each(function(index,el) {
|
||||
cb_area = $(el);
|
||||
cb_area.attr('id', "code-"+index);
|
||||
@@ -59,6 +24,7 @@ jQuery.fn.multicode_tabs_pandoc = function() {
|
||||
});
|
||||
});
|
||||
$('.multicode p').hide();
|
||||
$('.multicode .code_sample').css("position","static");
|
||||
|
||||
$('.multicode').minitabs();
|
||||
}
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -120,9 +120,9 @@
|
||||
|
||||
<div class="wrap container" role="document">
|
||||
<aside class="sidebar" role="complementary">
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
|
||||
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
|
||||
<li class="level-2"><a href="concept-fees.html">Fees (Disambiguation)</a></li>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -120,9 +120,9 @@
|
||||
|
||||
<div class="wrap container" role="document">
|
||||
<aside class="sidebar" role="complementary">
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
|
||||
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
|
||||
<li class="level-2"><a href="concept-fees.html">Fees (Disambiguation)</a></li>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -120,9 +120,9 @@
|
||||
|
||||
<div class="wrap container" role="document">
|
||||
<aside class="sidebar" role="complementary">
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
|
||||
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
|
||||
<li class="level-2"><a href="concept-fees.html">Fees (Disambiguation)</a></li>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -120,9 +120,9 @@
|
||||
|
||||
<div class="wrap container" role="document">
|
||||
<aside class="sidebar" role="complementary">
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: Best Practices</a></li>
|
||||
<li class="level-2"><a href="concept-issuing-and-operational-accounts.html">Issuing and Operational Acounts</a></li>
|
||||
<li class="level-2"><a href="tutorial-gateway-guide.html">Gateway Guide</a></li>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -120,9 +120,9 @@
|
||||
|
||||
<div class="wrap container" role="document">
|
||||
<aside class="sidebar" role="complementary">
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
|
||||
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
|
||||
<li class="level-2"><a href="concept-fees.html">Fees (Disambiguation)</a></li>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -120,9 +120,9 @@
|
||||
|
||||
<div class="wrap container" role="document">
|
||||
<aside class="sidebar" role="complementary">
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
|
||||
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
|
||||
<li class="level-2"><a href="concept-fees.html">Fees (Disambiguation)</a></li>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -120,9 +120,9 @@
|
||||
|
||||
<div class="wrap container" role="document">
|
||||
<aside class="sidebar" role="complementary">
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
|
||||
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
|
||||
<li class="level-2"><a href="concept-fees.html">Fees (Disambiguation)</a></li>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -120,9 +120,9 @@
|
||||
|
||||
<div class="wrap container" role="document">
|
||||
<aside class="sidebar" role="complementary">
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: Concepts</a></li>
|
||||
<li class="level-2"><a href="concept-paths.html">Paths</a></li>
|
||||
<li class="level-2"><a href="concept-fees.html">Fees (Disambiguation)</a></li>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -120,9 +120,9 @@
|
||||
|
||||
<div class="wrap container" role="document">
|
||||
<aside class="sidebar" role="complementary">
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: References</a></li>
|
||||
<li class="level-2"><a href="reference-rippled.html">rippled</a></li>
|
||||
<li class="level-2"><a href="reference-transaction-format.html">Transaction Format</a></li>
|
||||
@@ -186,6 +186,11 @@
|
||||
<li><a href="#get-account-balance-changes">Get Account Balance Changes - <code>GET /v2/accounts/{:address}/balance_changes</code></a></li>
|
||||
<li><a href="#get-account-reports">Get Account Reports - <code>GET /v2/accounts/{:address}/reports</code></a></li>
|
||||
</ul>
|
||||
<p>Health Checks:</p>
|
||||
<ul>
|
||||
<li><a href="#health-check-api">API Health Check - <code>GET /v2/health/api</code></a></li>
|
||||
<li><a href="#health-check-ledger-importer">Importer Health Check - <code>GET /v2/health/importer</code></a></li>
|
||||
</ul>
|
||||
<h2 id="get-ledger">Get Ledger</h2>
|
||||
<p><a href="https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/getLedger.js" title="Source">[Source]<br/></a></p>
|
||||
<p>Retrieve a specific Ledger by hash, index, date, or latest validated.</p>
|
||||
@@ -4432,6 +4437,219 @@ Content-Type: image/svg+xml
|
||||
]
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="health-check-api">Health Check - API</h2>
|
||||
<p><a href="https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/checkHealth.js" title="Source">[Source]<br/></a></p>
|
||||
<p>Check the health of the API service.</p>
|
||||
<div class="multicode">
|
||||
<p><em>REST</em></p>
|
||||
<pre><code>GET /v2/health/api
|
||||
</code></pre>
|
||||
</div>
|
||||
<p>Optionally, you can also include the following query parameters:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Value</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>threshold</td>
|
||||
<td>Integer</td>
|
||||
<td>Consider the API unhealthy if the database does not respond within this amount of time, in seconds. Defaults to 5 seconds.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>verbose</td>
|
||||
<td>Boolean</td>
|
||||
<td>If true, return a JSON response with data points. By default, return an integer value only.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="response-format-27">Response Format</h4>
|
||||
<p>A successful response uses the HTTP code <strong>200 OK</strong>. By default, the response body is an <strong>integer health value only</strong>. </p>
|
||||
<p>The health value <code>0</code> always indicates a healthy status. Other health values are defined as follows:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Value</th>
|
||||
<th>Meaning</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>0</code></td>
|
||||
<td>API service is up, and response time to HBase is less than <code>threshold</code> value from request.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>1</code></td>
|
||||
<td>API service is up, but response time to HBase is greater than <code>threshold</code> value from request.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>2</code></td>
|
||||
<td>API service was unable to contact HBase, or received an error in connecting.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>If the request specifies <code>verbose=true</code> in the query parameters, the response body is a JSON object, with the following fields:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Value</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>score</td>
|
||||
<td>0-2</td>
|
||||
<td>Health value, as defined above.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>response_time</td>
|
||||
<td>String - Human-readable time</td>
|
||||
<td>The actual response time of the database.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>response_time_threshold</td>
|
||||
<td>String - Human-readable time</td>
|
||||
<td>The maximum response time to be considered healthy.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="example-27">Example</h4>
|
||||
<p>Request:</p>
|
||||
<pre><code>GET /v2/health/api?verbose=true
|
||||
</code></pre>
|
||||
<p>Response:</p>
|
||||
<pre><code>{
|
||||
score: 0,
|
||||
response_time: "0.389s",
|
||||
response_time_threshold: "5s"
|
||||
}
|
||||
</code></pre>
|
||||
<h2 id="health-check-ledger-importer">Health Check - Ledger Importer</h2>
|
||||
<p><a href="https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/checkHealth.js" title="Source">[Source]<br/></a></p>
|
||||
<p>Check the health of the Ledger Importer Service.</p>
|
||||
<div class="multicode">
|
||||
<p><em>REST - Importer Health</em></p>
|
||||
<pre><code>GET /v2/health/importer
|
||||
</code></pre>
|
||||
</div>
|
||||
<p>Optionally, you can also include the following query parameters:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Value</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>threshold</td>
|
||||
<td>Integer</td>
|
||||
<td>Consider the Importer unhealthy if more than this amount of time, in seconds, has elapsed since the latest validated ledger was imported. Defaults to 300 seconds.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>threshold2</td>
|
||||
<td>Integer</td>
|
||||
<td>Consider the Importer unhealthy if more than this amount of time, in seconds, has elapsed since the latest ledger of any kind was imported. Defaults to 60 seconds.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>verbose</td>
|
||||
<td>Boolean</td>
|
||||
<td>If true, return a JSON response with data points. By default, return an integer value only.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="response-format-28">Response Format</h4>
|
||||
<p>A successful response uses the HTTP code <strong>200 OK</strong>. By default, the response body is an <strong>integer health value only</strong>. </p>
|
||||
<p>The health value <code>0</code> always indicates a healthy status. Other health values are defined as follows:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Value</th>
|
||||
<th>Meaning</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>0</code></td>
|
||||
<td>The most recent imported ledger was less than <code>threshold2</code> (Default: 60) seconds ago, and most recent validated ledger was less than <code>threshold</code> seconds ago.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>1</code></td>
|
||||
<td>The most recent imported ledger was less than <code>threshold2</code> (Default: 60) seconds ago, but the most recent validated ledger is older than <code>threshold</code> seconds.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>2</code></td>
|
||||
<td>The most recent imported ledger was more than <code>threshold2</code> seconds ago.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>3</code></td>
|
||||
<td>An error occurred when connecting to HBase, or the API was unable to determine when a ledger was most recently imported.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>If the request specifies <code>verbose=true</code> in the query parameters, the response body is a JSON object, with the following fields:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Value</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>score</td>
|
||||
<td>0-3</td>
|
||||
<td>Health value, as defined above.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>response_time</td>
|
||||
<td>String</td>
|
||||
<td>The actual response time of the database.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ledger_gap</td>
|
||||
<td>String - Human-readable time</td>
|
||||
<td>Difference between the close time of the last saved ledger and the current time.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>ledger_gap_threshold</td>
|
||||
<td>String - Human-readable time</td>
|
||||
<td>Maximum ledger gap to be considered healthy.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>valildation_gap</td>
|
||||
<td>String - Human-readable time</td>
|
||||
<td>Difference between the close time of the last imported validated ledger and the current time.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>validation_gap_threshold</td>
|
||||
<td>String - Human-readable time</td>
|
||||
<td>Maximum validation gap to be considered healthy.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="example-28">Example</h4>
|
||||
<p>Request:</p>
|
||||
<pre><code>GET /v2/health/importer?verbose=true
|
||||
</code></pre>
|
||||
<p>Response:</p>
|
||||
<pre><code>{
|
||||
"score": 0,
|
||||
"response_time": "0.081s",
|
||||
"ledger_gap": "1.891s",
|
||||
"ledger_gap_threshold": "5.00m",
|
||||
"validation_gap": "29.894s",
|
||||
"validation_gap_threshold": "15.00m"
|
||||
}
|
||||
</code></pre>
|
||||
<h1 id="api-conventions">API Conventions</h1>
|
||||
<h2 id="basic-types">Basic Types</h2>
|
||||
<p>As a REST API, the Data API v2 uses <a href="http://json.org/">JSON</a>'s native datatypes to represent API fields, with some special cases.</p>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -120,9 +120,9 @@
|
||||
|
||||
<div class="wrap container" role="document">
|
||||
<aside class="sidebar" role="complementary">
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: References</a></li>
|
||||
<li class="level-2"><a href="reference-rippled.html">rippled</a></li>
|
||||
<li class="level-2"><a href="reference-transaction-format.html">Transaction Format</a></li>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -120,9 +120,9 @@
|
||||
|
||||
<div class="wrap container" role="document">
|
||||
<aside class="sidebar" role="complementary">
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: References</a></li>
|
||||
<li class="level-2"><a href="reference-rippled.html">rippled</a></li>
|
||||
<li class="level-2"><a href="reference-transaction-format.html">Transaction Format</a></li>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -120,9 +120,9 @@
|
||||
|
||||
<div class="wrap container" role="document">
|
||||
<aside class="sidebar" role="complementary">
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: References</a></li>
|
||||
<li class="level-2"><a href="reference-rippled.html">rippled</a></li>
|
||||
<li class="level-2"><a href="reference-transaction-format.html">Transaction Format</a></li>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -120,9 +120,9 @@
|
||||
|
||||
<div class="wrap container" role="document">
|
||||
<aside class="sidebar" role="complementary">
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: References</a></li>
|
||||
<li class="level-2"><a href="reference-rippled.html">rippled</a></li>
|
||||
<li class="level-2"><a href="reference-transaction-format.html">Transaction Format</a></li>
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -21,9 +21,9 @@
|
||||
|
||||
{% block sidebar %}
|
||||
{% if currentpage.sidebar %}
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: {{ currentpage.category }}</a></li>
|
||||
{% for page in pages %}
|
||||
{% if page.category == currentpage.category %}
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -120,9 +120,9 @@
|
||||
|
||||
<div class="wrap container" role="document">
|
||||
<aside class="sidebar" role="complementary">
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: Best Practices</a></li>
|
||||
<li class="level-2"><a href="concept-issuing-and-operational-accounts.html">Issuing and Operational Acounts</a></li>
|
||||
<li class="level-2"><a href="tutorial-gateway-guide.html">Gateway Guide</a></li>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -120,9 +120,9 @@
|
||||
|
||||
<div class="wrap container" role="document">
|
||||
<aside class="sidebar" role="complementary">
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: Tutorials</a></li>
|
||||
<li class="level-2"><a href="tutorial-rippleapi-beginners-guide.html">RippleAPI Beginners Guide</a></li>
|
||||
<li class="level-2"><a href="tutorial-rippled-setup.html">rippled Setup</a></li>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -120,9 +120,9 @@
|
||||
|
||||
<div class="wrap container" role="document">
|
||||
<aside class="sidebar" role="complementary">
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: Tutorials</a></li>
|
||||
<li class="level-2"><a href="tutorial-rippleapi-beginners-guide.html">RippleAPI Beginners Guide</a></li>
|
||||
<li class="level-2"><a href="tutorial-rippled-setup.html">rippled Setup</a></li>
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
<script src="assets/js/multicodetab.js"></script>
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$().multicode_tabs_pandoc();
|
||||
$().multicode_tabs();
|
||||
hljs.initHighlighting();
|
||||
make_code_expandable();
|
||||
});
|
||||
@@ -120,9 +120,9 @@
|
||||
|
||||
<div class="wrap container" role="document">
|
||||
<aside class="sidebar" role="complementary">
|
||||
<div class="dev_nav_wrapper" style="margin-bottom: 0px;">
|
||||
<div class="dev_nav_wrapper">
|
||||
<div id="cont">
|
||||
<ul id="dev_nav_sidebar">
|
||||
<ul class="dev_nav_sidebar">
|
||||
<li class="level-1"><a href="index.html">Category: Tutorials</a></li>
|
||||
<li class="level-2"><a href="tutorial-rippleapi-beginners-guide.html">RippleAPI Beginners Guide</a></li>
|
||||
<li class="level-2"><a href="tutorial-rippled-setup.html">rippled Setup</a></li>
|
||||
|
||||
Reference in New Issue
Block a user