Commit Graph

104 Commits

Author SHA1 Message Date
mDuo13
582717de76 Clustering: improve tutorial, revise related API methods 2018-09-13 15:32:32 -07:00
wilsonianb
a9469a7fbd Fix DirectoryNode RootIndex type 2018-09-13 10:37:04 -05:00
mDuo13
4ca5761df5 Data API: Remove Get Capitalization 2018-09-06 11:07:37 -07:00
mDuo13
a82b70fa15 Data API: remove ToC link to removed method 2018-09-04 13:34:56 -07:00
mDuo13
45597ec5ed Update Data API docs for v2.3.5 2018-08-31 16:18:20 -07:00
mDuo13
d1d4f3fcf2 Data API: Remove unsupported 'descending' param from Get Act. Payments 2018-08-03 14:42:03 -07:00
Elliot Lee
6fa0760a7a PaymentChannelFund - fix minor typo 2018-07-17 21:26:08 -07:00
Scott Schurr
6b8abd83a7 Update public-rippled-methods.md
Fix minor typo in `account_tx` link description.
2018-07-03 16:22:36 -07:00
Rome Reginelli
998c8e0161 Merge pull request #428 from mDuo13/rippled-cli-ref
Add rippled commandline reference
2018-07-02 14:46:28 -07:00
mDuo13
c4ccc06368 CLI usage edits per reviews 2018-07-02 14:22:48 -07:00
mDuo13
3334e3c216 CLI ref: revisions per review 2018-06-27 15:57:15 -07:00
mDuo13
4fc2107456 Add common link defs to CLI usage 2018-06-26 16:13:02 -07:00
mDuo13
e0a0a86151 Add rippled commandline reference 2018-06-26 15:33:50 -07:00
mDuo13
70005889b6 Progress on commandline usage 2018-06-22 17:16:57 -07:00
Rome Reginelli
21e1ddb1db Merge pull request #422 from mikemilano/patch-9
Removed duplicate message from checkcash.md
2018-06-20 15:18:14 -07:00
Rome Reginelli
0156d43e35 Merge pull request #421 from mikemilano/patch-8
Removed duplicate field intro in checkcancel.md
2018-06-20 15:17:58 -07:00
Mike Milano
2b05359493 Removed duplicate message from checkcreate.md
It looks like the field intro was optimized to use a snippet, but the original intro text was left in, duplicating the field intro message.
2018-06-18 00:07:11 -07:00
Mike Milano
90212e5353 Removed duplicate message from checkcash.md
It looks like the field intro was optimized to use a snippet, but the original intro text was left in, duplicating the field intro message.
2018-06-18 00:05:52 -07:00
Mike Milano
b52ba46a5c Removed duplicate field intro in checkcancel.md
It looks like the field intro was optimized to use a snippet, but the original intro text was left in, duplicating the field intro message.
2018-06-18 00:04:43 -07:00
mDuo13
4055f6c074 rippled CLI - clarify --validateShards 2018-06-15 14:39:08 -07:00
mDuo13
188a7a640d Expand CLI usage ref draft 2018-06-13 15:19:24 -07:00
Rome Reginelli
3cca172e0e Merge pull request #414 from mDuo13/doc1568
Update ledger_entry method
2018-06-07 13:32:09 -07:00
mDuo13
5e0c470059 Fix 'only [one] of' typo 2018-06-07 12:51:31 -07:00
mDuo13
90f73b3eef Start CLI reference 2018-06-06 18:13:35 -07:00
mDuo13
c091229307 ledger_entry - Clean up DirectoryNode language per @jbheron 2018-06-06 13:04:33 -07:00
Mike Milano
e9a8af0345 Fixed invalid JSON response in noripple_check
A trailing comma was left in the last item of the `result.problems` array in the JSON-RPC example response of noripple_check.

I'm actually creating json files with the examples to mock responses in unit tests for the library I'm writing, so my tests found it. I wouldn't have noticed otherwise. I'm grateful we have example responses to review and copy!
2018-05-31 04:12:43 -07:00
Rome Reginelli
02126cd68f Merge pull request #405 from mDuo13/data_api_updates
Update Data API reference
2018-05-30 13:35:33 -07:00
Rome Reginelli
7aa54d00f7 Merge pull request #410 from mikemilano/patch-5
Removed ledger param from account_objects
2018-05-30 13:32:33 -07:00
Mike Milano
6c148f9aaf Removed ledger param from account_objects
Similar to PR #409 except the deprecated `ledger` param was used in the websocket request example, while `ledger_index` was used in the JSON example.

This PR removes those parameters on both examples. I also removed the word `Optional` from the `Type` column since the convention seems to be to indicate that in the description field.

Note: The Commandline request example has `[ledger_index]`, however the syntax suggests it's an optional argument and not an flagged option (i.e. `--ledger_index=current`), so it seems proper to leave that as is.
2018-05-30 02:54:06 -07:00
Mike Milano
9a0ffd280d Removed ledger parameter from request
The `ledger` parameter is now `ledger_index`, which is optional and defaults to current. This PR removes the `ledger` param from the example requests.

I had opened a PR to simply change `ledger` to `ledger_index`, however the conventions of the API docs seem to only use required parameters, so I closed that PR and created this one instead.
2018-05-30 02:40:34 -07:00
mDuo13
532ffb7c61 Data API style consistencies.
- End description cells with a period
- Use 'The default is' instead of 'Defaults to'
- Auto table column widths
- Put 'rippled' in code font
- Put 'true' and 'false' in code font
- Remove colons from URL templates per RFC6570
- Fix missing column in fee method description
2018-05-30 00:07:15 -07:00
mDuo13
aadce6e09d ledger_entry: new types from rippled 1.0.0 (draft)
Also adds some missing error types and uses more consistent terminology
for object IDs.

(Resolves DOC-1568)
2018-05-29 15:22:13 -07:00
Mike Milano
e5ce519c58 Missing Optional flag for hotwallet param
The `hotwallet` parameter of `gateway-balances()` didn't seem like the type of parameter that needs to be required. I tested the API w/o it and it returned successfully.
2018-05-24 03:39:32 -07:00
mDuo13
351e176f77 Update Data API reference 2018-05-23 17:14:46 -07:00
Rome Reginelli
adbee4d75e Merge pull request #403 from mDuo13/doc1570
fix1571 update to EscrowCreate
2018-05-23 16:09:55 -07:00
mDuo13
616ee9c2e6 Clarify tx flags per review 2018-05-23 15:56:30 -07:00
mDuo13
3606ecd63b Flag ranges table spacing 2018-05-23 15:52:29 -07:00
mDuo13
a9746f5795 Clarify flag ranges 2018-05-23 15:52:29 -07:00
mDuo13
8d85577b04 Rephrase escrowcreate fix1571 changes per @jhaaaa review 2018-05-23 15:52:06 -07:00
mDuo13
7ec57d02e8 fix1571 update to EscrowCreate 2018-05-23 15:52:06 -07:00
Jennifer Hasegawa
807fc8d83f fix admin meth landing 2018-05-22 15:05:19 -07:00
Jennifer Hasegawa
c448ded402 Merge pull request #393 from jhaaaa/ledger-format-land
Fix ledger data format and obj type landings
2018-05-22 09:38:41 -07:00
Jennifer Hasegawa
ed5c439e4f Merge pull request #395 from jhaaaa/pub-method-land
Fixes to Public Methods landing page
2018-05-22 09:38:19 -07:00
Jennifer Hasegawa
7ecf644034 fix rippled api landing 2018-05-21 12:17:23 -07:00
Jennifer Hasegawa
57606ae12a inc'd feedback 2018-05-18 13:46:38 -07:00
Jennifer Hasegawa
1737738b19 Merge pull request #392 from jhaaaa/trans-results-land
Fix transaction results landing page
2018-05-18 11:24:53 -07:00
Jennifer Hasegawa
47f615bfd5 public methods landing 2018-05-17 14:13:53 -07:00
Jennifer Hasegawa
40f1d112cc bold links 2018-05-17 10:20:07 -07:00
Jennifer Hasegawa
6f846deaf0 initial changes 2018-05-17 09:41:40 -07:00
Jennifer Hasegawa
529cd1f13c fix ledger data format landing 2018-05-16 18:26:21 -07:00