ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-12-01 09:05:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

[FIX+FEATURE] API tool fixes, links; code block styling fixes; removed dead /p

Browse Source
This commit is contained in:
mDuo13
2014-09-11 15:20:43 -07:00
parent e11a6e3107
commit f01b31e472
11 changed files with 42 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
consensus-whitepaper.html
View File

@@ -193,7 +193,6 @@ mixpanel.init("132d42885e094171f34467fc54da6fab");
<!--End mc_embed_signup-->
</div>
</div>
</p>
</div>
</div>
</body>

10
css/custom.css
View File

@@ -54,10 +54,16 @@ body .content-root {
margin-top: -50px;
}
/* Undo some of bootstrap's code styling that clashes */
.content pre code {
white-space: pre;
}
.content pre {
background: none;
}
/* end bootstrap code styling fix */
.menubar {
padding-top: 10px;
}
@@ -81,6 +87,10 @@ color: #f09 !important;
float:right;
}
#selected_command a:hover {
text-decoration: underline;
}
/* Brand Guidelines */
.brand_guidelines .content-root {

1
gatewayd.html
View File

@@ -169,7 +169,6 @@ mixpanel.init("132d42885e094171f34467fc54da6fab");
<!--End mc_embed_signup-->
</div>
</div>
</p>
</div>
</div>
</body>

5
index.html
View File

@@ -10,7 +10,7 @@
<link href="css/bootstrap.min.css" rel="stylesheet">
<!-- Google Font -->
<link href='http://fonts.googleapis.com/css?family=Open+Sans:400,300,600' rel='stylesheet' type='text/css'>
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,300,600' rel='stylesheet' type='text/css'>
<!-- Font Awesome -->
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css" rel="stylesheet">
@@ -97,7 +97,7 @@ mixpanel.init("132d42885e094171f34467fc54da6fab");
<h4>Build on the world's first protocol for value exchange</h4>
<p class="main_callout">Ripple is a protocol for making financial transactions worldwide, with no central authority responsible for managing it. Anyone can run a server, connect to the network, and start doing business. Get started by submitting API calls to our public servers now.</p>
<p class="api_btn"><a target="_blank" href="https://ripple.com/tools/api/"><button type="button" class="button btn btn-primary api">Try it!</button></a></p>
<p class="api_btn"><a target="_blank" href="ripple-api-tool.html"><button type="button" class="button btn btn-primary api">Try it!</button></a></p>
</div>
</div>
</div>
@@ -261,7 +261,6 @@ mixpanel.init("132d42885e094171f34467fc54da6fab");
<!--End mc_embed_signup-->
</div>
</div>
</p>
</div>
</div>

42
js/api-main.js
View File

@@ -92,17 +92,17 @@
Request('server_info', {
_description: 'Returns information about the state of the server for human consumption. Results are subject to change without notice.',
_link: 'https://ripple.com/wiki/JSON_Messages#server_info'
_link: 'rippled-apis.html#server-info'
});
Request('server_state', {
_description: 'Returns information about the state of the server for machine consumption.',
_link: 'https://ripple.com/wiki/JSON_Messages#server_state'
_link: 'rippled-apis.html#server-state'
});
Request('ping', {
_description: 'This command is used to check connectivity for clients. Websocket clients can use this to determine turn around time and actively discover loss of connectivity to a server.',
_link: 'https://ripple.com/wiki/JSON_Messages#ping'
_link: 'rippled-apis.html#ping'
});
/* ---- ---- */
@@ -111,14 +111,14 @@
accounts: [ ],
streams: [ 'server', 'ledger' ],
_description: 'Start receiving selected streams from the server.',
_link: 'https://ripple.com/wiki/JSON_Messages#subscribe'
_link: 'rippled-apis.html#subscribe'
});
Request('unsubscribe', {
accounts: [ ],
streams: [ 'server', 'ledger' ],
_description: 'Stop receiving selected streams from the server.',
_link: 'https://ripple.com/wiki/JSON_Messages#unsubscribe'
_link: 'rippled-apis.html#unsubscribe'
});
/* ---- ---- */
@@ -131,7 +131,7 @@
transactions: true,
accounts: true,
_description: 'Returns ledger information.',
_link: 'https://ripple.com/wiki/JSON_Messages#ledger'
_link: 'rippled-apis.html#ledger'
});
Request('ledger_entry', {
@@ -140,17 +140,17 @@
ledger_hash: 'validated',
ledger_index: void(0),
_description: 'Returns a ledger entry. For untrusted servers, the index option provides raw access to ledger entries and proof.',
_link: 'https://ripple.com/wiki/JSON_Messages#ledger_entry'
_link: 'rippled-apis.html#ledger-entry'
});
Request('ledger_closed', {
_description: 'Returns the most recent closed ledger index. If a validation list has been provided, then validations should be available.',
_link: 'https://ripple.com/wiki/JSON_Messages#ledger_closed'
_link: 'rippled-apis.html#ledger-closed'
});
Request('ledger_current', {
_description: 'Returns the current proposed ledger index. Proof is not possible for the current ledger. This command is primarily useful for testing.',
_link: 'https://ripple.com/wiki/JSON_Messages#ledger_current'
_link: 'rippled-apis.html#ledger-current'
});
/* ---- ---- */
@@ -158,7 +158,7 @@
Request('account_info', {
account: sample_address,
_description: 'Returns information about the specified account.',
_link: 'https://ripple.com/wiki/JSON_Messages#account_info'
_link: 'rippled-apis.html#account-info'
});
Request('account_lines', {
@@ -166,7 +166,7 @@
account_index: void(0),
ledger: 'current',
_description: 'Returns information about the ripple credit lines for the specified account.',
_link: 'https://ripple.com/wiki/JSON_Messages#account_lines'
_link: 'rippled-apis.html#account-lines'
});
Request('account_offers', {
@@ -174,7 +174,7 @@
account_index: void(0),
ledger: 'current',
_description: 'Returns the outstanding offers for a specified account.',
_link: 'https://ripple.com/wiki/JSON_Messages#account_offers'
_link: 'rippled-apis.html#account-offers'
});
Request('account_tx', {
@@ -189,7 +189,7 @@
forward: false,
marker: void(0),
_description: 'Returns a list of transactions that applied to a specified account.',
_link: 'https://ripple.com/wiki/JSON_Messages#account_tx'
_link: 'rippled-apis.html#account-tx'
});
/* ---- ---- */
@@ -199,19 +199,19 @@
ledger_index: 348734,
ledger_hash: void(0),
_description: 'Returns information about a specified transaction.',
_link: 'https://ripple.com/wiki/JSON_Messages#transaction_entry'
_link: 'rippled-apis.html#transaction-entry'
});
Request('tx', {
transaction: sample_tx,
_description: 'Returns information about a specified transaction.',
_link: 'https://ripple.com/wiki/JSON_Messages#tx'
_link: 'rippled-apis.html#tx'
});
Request('tx_history', {
start: 10,
_description: 'Returns the last N transactions starting from start index, in descending order, by ledger sequence number. Server sets N.',
_link: 'https://ripple.com/wiki/JSON_Messages#tx_history'
_link: 'rippled-apis.html#tx-history'
});
Request('book_offers', {
@@ -221,7 +221,7 @@
taker_gets: ripple.Amount.from_json('1/EUR/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B').to_json(),
taker_pays: ripple.Amount.from_json('1/USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B').to_json(),
_description: 'Returns the offers for an order book as one or more pages.',
_link: 'https://ripple.com/wiki/JSON_Messages#book_offers'
_link: 'rippled-apis.html#book-offers'
});
Request('path_find', {
@@ -230,7 +230,7 @@
destination_account: 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59',
destination_amount: ripple.Amount.from_json('0.001/USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B').to_json(),
_description: 'Find or modify a payment pathway between specified accounts.',
_link: 'https://ripple.com/wiki/JSON_Messages#path_find'
_link: 'rippled-apis.html#path-find'
});
Request('ripple_path_find', {
@@ -240,8 +240,8 @@
source_currencies : [ { currency : 'USD' } ],
destination_account : 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59',
destination_amount : ripple.Amount.from_json('0.001/USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B').to_json(),
_description: 'Find a path and estimated costs.For non-interactive use, such as automated payment sending from business integrations, ripple_path_find gives you single response that you can use immediately. However, for uses that need updated paths as new ledgers close, repeated calls becomes expensive. In those cases, when possible, use the RPC path_find in place of this API.',
_link: 'https://ripple.com/wiki/JSON_Messages#ripple_path_find'
_description: 'Find a path and estimated costs. For non-interactive use, such as automated payment sending from business integrations, ripple_path_find gives you single response that you can use immediately. However, for uses that need updated paths as new ledgers close, repeated calls becomes expensive. In those cases, when possible, use the RPC path_find in place of this API.',
_link: 'rippled-apis.html#ripple-path-find'
});
Request('submit', {
@@ -255,7 +255,7 @@
Flags: 0
},
_description: 'Submits a transaction to the network.',
_link: 'https://ripple.com/wiki/JSON_Messages#submit'
_link: 'rippled-apis.html#submit'
});
/* ---- ---- ---- ---- ---- */

2
ripple-api-tool.html
View File

@@ -136,7 +136,7 @@ mixpanel.init("132d42885e094171f34467fc54da6fab");
<div id='sign_button'>Sign transaction</div>
</div>
<div style="clear:both;"></div>
<h3 id='selected_command'>server_info</h3>
<h3 id='selected_command' title='Reference information'>server_info</h3>
<p id='description'></p>
<div id='invalid'>Invalid JSON</div>
<p>JSON</p>

3
ripple-rest.html
View File

@@ -92,7 +92,7 @@ mixpanel.init("132d42885e094171f34467fc54da6fab");
<li><a href="https://ripplelabs.atlassian.net/">Bug Tracking</a></li>
<li><a href="https://ripple.com/dev/blog/">Dev Blog</a></li>
<li><a href="https://ripple.com/forum/viewforum.php?f=2&sid=c016bc6b934120b7117c0e136e74de98">Forums</a></li>
<li><a target="_self" href="ripple-api-tool.html">API Tool</a></li>
<li><a href="ripple-api-tool.html">API Tool</a></li>
</ul>
<div class='right'>
<!-- GitHub buttons -->
@@ -182,7 +182,6 @@ mixpanel.init("132d42885e094171f34467fc54da6fab");
<!--End mc_embed_signup-->
</div>
</div>
</p>
</div>
</div>
</body>

7
rippled-apis.html
View File

@@ -10,8 +10,6 @@
<!-- favicon -->
<link rel="icon" href="favicon.ico" type="image/x-icon">
<link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
<script src="http://cdn.mxpnl.com/libs/mixpanel-2.2.min.js" async="" type="text/javascript"></script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
<!-- Flatdoc -->
@@ -44,7 +42,7 @@ b._i.push([a,e,d])};b.__SV=1.2}})(document,window.mixpanel||[]);
mixpanel.init("132d42885e094171f34467fc54da6fab");
</script>
<script>if (window.location.host == "dev.ripple.com") { mixpanel.track("rippled-apis"); }</script>
<script>if (window.location.host == "dev.ripple.com") { mixpanel.track("rippled-apis"); } else if (window.location.host == "localhost") { mixpanel.track("localhost-rippled-apis"); }</script>
<!-- end Mixpanel -->
<!-- start google analytics -->
@@ -106,6 +104,7 @@ mixpanel.init("132d42885e094171f34467fc54da6fab");
<li><a href="https://ripplelabs.atlassian.net/">Bug Tracking</a></li>
<li><a href="https://ripple.com/dev/blog/">Dev Blog</a></li>
<li><a href="https://ripple.com/forum/viewforum.php?f=2&amp;sid=c016bc6b934120b7117c0e136e74de98">Forums</a></li>
<li><a href="ripple-api-tool.html">API Tool</a></li>
</ul>
<div class="right">
<!-- GitHub buttons -->
@@ -141,7 +140,7 @@ mixpanel.init("132d42885e094171f34467fc54da6fab");
<li>A malicious server could report that you were paid when no such payment was made</li>
<li>It could selectively show or hide payment paths and currency exchange offers to guarantee its own profit while not providing you the best deal</li>
<li>If you sent it your account’s secret, it could make arbitrary transactions on your behalf, and even transfer or destroy all the money in your account’s balances.</li>
</ul><p>Additionally, running your own server gives you admin control over it, which allows you to run important admin-only and load-intensive commands. If you use a shared server, you have to worry about other users of the same server competing with you for the server’s computing power. Many of the commands in the WebSocket API can put a lot of strain on the server, so <code title="Double-click to expand/collapse">rippled</code> has the option to scale back its responses when it needs to. If you share a server with others, you may not always get the best results possible.</p><h3 id="websocket-api">WebSocket API</h3><p>If you are just looking to try out some methods on the Ripple network, you can skip writing your own WebSocket code and go straight to using the API at the <a href="https://ripple.com/tools/api/">Ripple WebSocket API Tool</a>. Later on, when you want to connect to your own <code title="Double-click to expand/collapse">rippled</code> server, you can build your own client in Javascript to run in a browser (See <a href="http://www.websocket.org/echo.html">this example</a> ) or possibly <a href="https://github.com/einaros/ws">Node.js</a>.</p><p>Currently Ripple Labs maintains a set of public WebSocket servers at:</p><table>
</ul><p>Additionally, running your own server gives you admin control over it, which allows you to run important admin-only and load-intensive commands. If you use a shared server, you have to worry about other users of the same server competing with you for the server’s computing power. Many of the commands in the WebSocket API can put a lot of strain on the server, so <code title="Double-click to expand/collapse">rippled</code> has the option to scale back its responses when it needs to. If you share a server with others, you may not always get the best results possible.</p><h3 id="websocket-api">WebSocket API</h3><p>If you are just looking to try out some methods on the Ripple network, you can skip writing your own WebSocket code and go straight to using the API at the <a href="ripple-api-tool.html">Ripple WebSocket API Tool</a>. Later on, when you want to connect to your own <code title="Double-click to expand/collapse">rippled</code> server, you can build your own client in Javascript to run in a browser (See <a href="http://www.websocket.org/echo.html">this example</a> ) or possibly <a href="https://github.com/einaros/ws">Node.js</a>.</p><p>Currently Ripple Labs maintains a set of public WebSocket servers at:</p><table>
<thead>
<tr>
<th>Domain</th>

2
ripplerest_api.md
View File

@@ -1,4 +1,4 @@
## Ripple-REST API ##
# Ripple-REST API #
The `ripple-rest` API makes it easy to access the Ripple system via a RESTful web interface. In this section, we will cover the concepts you need to understand, and get you started accessing the API and learning how to use it.

4
terms-conditions.html
View File

@@ -10,7 +10,7 @@
<link href="css/bootstrap.min.css" rel="stylesheet">
<!-- Google Font -->
<link href='http://fonts.googleapis.com/css?family=Open+Sans:400,300,600' rel='stylesheet' type='text/css'>
<link href='https://fonts.googleapis.com/css?family=Open+Sans:400,300,600' rel='stylesheet' type='text/css'>
<!-- Font Awesome -->
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css" rel="stylesheet">
@@ -74,7 +74,7 @@ mixpanel.init("132d42885e094171f34467fc54da6fab");
<li><a href="https://ripplelabs.atlassian.net/">Bug Tracking</a></li>
<li><a href="https://ripple.com/dev/blog/">Dev Blog</a></li>
<li><a href="https://ripple.com/forum/viewforum.php?f=2&sid=c016bc6b934120b7117c0e136e74de98">Forums</a></li>
<li><a target="_self" href="ripple-api-tool.html">API Tool</a></li>
<li><a href="ripple-api-tool.html">API Tool</a></li>
</ul>
<div class='right'>
<!-- GitHub buttons -->

2
websocket_api.md
View File

@@ -33,7 +33,7 @@ Additionally, running your own server gives you admin control over it, which all
### WebSocket API ###
If you are just looking to try out some methods on the Ripple network, you can skip writing your own WebSocket code and go straight to using the API at the [Ripple WebSocket API Tool](https://ripple.com/tools/api/). Later on, when you want to connect to your own `rippled` server, you can build your own client in Javascript to run in a browser (See [this example](http://www.websocket.org/echo.html) ) or possibly [Node.js](https://github.com/einaros/ws).
If you are just looking to try out some methods on the Ripple network, you can skip writing your own WebSocket code and go straight to using the API at the [Ripple WebSocket API Tool](ripple-api-too.html). Later on, when you want to connect to your own `rippled` server, you can build your own client in Javascript to run in a browser (See [this example](http://www.websocket.org/echo.html) ) or possibly [Node.js](https://github.com/einaros/ws).
Currently Ripple Labs maintains a set of public WebSocket servers at: