ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-12-06 17:27:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

[MERGE] catch up w/ typofixes from master

Browse Source
This commit is contained in:
mDuo13
2014-10-20 17:26:52 -07:00
parent 3a07fdac5e 59e7877856
commit 7685f0eec1
4 changed files with 12 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -1,12 +1,6 @@
ripple-dev-portal
=================
This Ripple Developer Portal is focused solely on documentation for the [`ripple-rest`](https://github.com/ripple/ripple-rest) API. The developer portal is a static site leveraging a fork of [`flatdoc`](https://github.com/rstacruz/flatdoc).
The documentation is stored in the "API.md" file in the root of the `ripple-dev-portal` repository. Versioning for the documentation will match the tagged release version for `ripple-rest`.
### The ripple-dev-portal is currently hosted at https://dev.ripple.com ###
The [Ripple Developer Portal](https://dev.ripple.com) is the authoritative source for Ripple documentation, including the `rippled` server, Ripple-REST API, Gatewayd, and other Ripple software.
Please contribute pull requests to the **gh-pages** branch with any improvements or revisions.

2
gatewayd.md
View File

@@ -322,7 +322,7 @@ The API serves several purposes: it provides an easy way to customize settings w
* [Retrieve Hot Wallet - `GET /v1/config/wallets/hot`](#retrieve-hot-wallet)
* [Set Last Payment Hash - `POST /v1/config/last_payment_hash`](#set-last-payment-hash)
* [Retrieve Last Payment Hash - `GET /v1/config/last_payment_hash`](#retrieve-last-payment-hash)
* [Set Gateway Domain - `POST /v1/config/domin`](#set-gateway-domain)
* [Set Gateway Domain - `POST /v1/config/domain`](#set-gateway-domain)
* [Retrieve Domain - `GET /v1/config/domain`](#retrieve-domain)
* [Set API Key - `POST /v1/config/key`](#set-api-key)
* [Retrieve API Key - `GET /v1/config/key`](#retrieve-api-key)

8
js/apitool-rest.js
View File

@@ -186,7 +186,7 @@ Request("Get Trustlines", {
method: GET,
path: "/v1/accounts/{:address}/trustlines?{:query_params}",
description: "Check the status of one or more trustlines attached to an account",
link: "#reviewing-trustlines",
link: "#get-trustlines",
params: {
"{:address}": DEFAULT_ADDRESS_1,
"{:query_params}": "currency=USD&counterparty=ra5nK24KXen9AHvsdFTKHSANinZseWnPcX"
@@ -197,7 +197,7 @@ Request("Grant Trustline", {
method: POST,
path: "/v1/accounts/{:address}/trustlines",
description: "Add or modify a trustline from this account.",
link: "#granting-a-trustline",
link: "#grant-trustline",
test_only: true,
params: {
"{:address}": DEFAULT_ADDRESS_1
@@ -217,7 +217,7 @@ Request("Check Notifications", {
method: GET,
path: "/v1/accounts/{:address}/notifications/{:hash}",
description: "Browse through the history of payments sent and received by an account",
link: "#checking-notifications",
link: "#check-notifications",
params: {
"{:address}": DEFAULT_ADDRESS_1,
"{:hash}": DEFAULT_HASH
@@ -228,7 +228,7 @@ Request("Check Connection", {
method: GET,
path: "/v1/server/connected",
description: "Check whether the REST server is connected to a rippled server",
link: "#check-connection-state"
link: "#check-connection"
});
Request("Get Server Status", {

10
ripplerest_api.md
View File

@@ -25,16 +25,16 @@ Installation instructions and source code can be found in the [Ripple-REST repos
#### Trustlines ####
* [Get Trustlines - `GET /v1/accounts/{:address}/trustlines`](#reviewing-trustlines)
* [Grant Trustline - `POST /v1/accounts/{:address}/trustlines`](#granting-a-trustline)
* [Get Trustlines - `GET /v1/accounts/{:address}/trustlines`](#get-trustlines)
* [Grant Trustline - `POST /v1/accounts/{:address}/trustlines`](#grant-trustline)
#### Notifications ####
* [Check Notifications - `GET /v1/accounts/{:address}/notifications/{:transaction_hash}`](#checking-notifications)
* [Check Notifications - `GET /v1/accounts/{:address}/notifications/{:transaction_hash}`](#check-notifications)
#### Status ####
* [Check Connection - `GET /v1/server/connected`](#check-connection-state)
* [Check Connection - `GET /v1/server/connected`](#check-connection)
* [Get Server Status - `GET /v1/server`](#get-server-status)
#### Utilities ####
@@ -831,7 +831,7 @@ The following URL parameters are required by this API endpoint:
| Field | Type | Description |
|-------|------|-------------|
| payment | Object | A [payment object](#payment-object) for the transaction. |
| payment | Object | A [payment object](#payment-objects) for the transaction. |
If the `payment.state` field has the value `"validated"`, then the payment has been finalized, and is included in the shared global ledger. However, this does not necessarily mean that it succeeded. Check the `payment.result` field for a value of `"tesSUCCESS"` to see if the payment was successfully executed. If the `payment.partial_payment` flag is *true*, then you should also consult the `payment.destination_balance_changes` array to see how much currency was actually delivered to the destination account.