[REST] Update API docs to add Get Order Transaction

- Updates Payments API
- Adds a new response object `Order Change` to describe changes to
  orders in the order book
- Update all source code URLs to permalinks
-
This commit is contained in:
Alan Cohen
2015-02-08 16:19:34 -08:00
parent 45861ee4cf
commit df7e0a1dbf
3 changed files with 362 additions and 516 deletions

File diff suppressed because it is too large Load Diff

View File

@@ -237,7 +237,7 @@ Request("Cancel Order", {
Request("Get Account Orders", { Request("Get Account Orders", {
method: GET, method: GET,
path: "/v1/accounts/{:address}/orders?{:query_params}", path: "/v1/accounts/{:address}/orders?{:query_params}",
description: "Check the status of one or more orders attached to an account.", description: "Get open currency-exchange orders associated with the Ripple address.",
link: "#get-account-orders", link: "#get-account-orders",
params: { params: {
"{:address}": DEFAULT_ADDRESS_3, "{:address}": DEFAULT_ADDRESS_3,
@@ -245,6 +245,17 @@ Request("Get Account Orders", {
} }
}); });
Request("Get Order Transaction", {
method: GET,
path: "/v1/accounts/{:address}/orders/{:hash}",
description: "Get the details of an order transaction.",
link: "#get-order-transaction",
params: {
"{:address}": "rEQWVz1qN4DWw5J17s3DgXQzUuVYDSpK6M",
"{:hash}": "D53A3B99AC0C3CAF35D72178390ACA94CD42479A98CEA438EEAFF338E5FEB76D"
}
});
Request("Get Order Book", { Request("Get Order Book", {
method: GET, method: GET,
path: "/v1/accounts/{:address}/order_book/{:base}/{:counter}?{:query_params}", path: "/v1/accounts/{:address}/order_book/{:base}/{:counter}?{:query_params}",

View File

@@ -99,6 +99,7 @@
<li>Place Order</li> <li>Place Order</li>
<li>Cancel Order</li> <li>Cancel Order</li>
<li>Get Account Orders</li> <li>Get Account Orders</li>
<li>Get Order Transaction</li>
<li>Get Order Book</li> <li>Get Order Book</li>
<br/> <br/>
<li>Get Trustlines</li> <li>Get Trustlines</li>