Merge pull request #450 from mDuo13/conventions-blurbs

API Conventions blurbs & minor cleanup
This commit is contained in:
Rome Reginelli
2018-08-24 14:30:57 -07:00
committed by GitHub

View File

@@ -104,7 +104,6 @@ pages:
targets: targets:
- local - local
#TODO: DOC-1503: replace this with a more concise intro to consensus
- md: concepts/introduction/intro-to-consensus.md - md: concepts/introduction/intro-to-consensus.md
html: intro-to-consensus.html html: intro-to-consensus.html
funnel: Docs funnel: Docs
@@ -981,14 +980,15 @@ pages:
targets: targets:
- local - local
- md: references/rippled-api/api-conventions/basic-data-types.md - md: references/rippled-api/api-conventions/basic-data-types.md
html: basic-data-types.html html: basic-data-types.html
funnel: Docs funnel: Docs
doc_type: References doc_type: References
supercategory: rippled API supercategory: rippled API
category: API Conventions category: API Conventions
targets: blurb: Format and meaning of fundamental data types like addresses, ledger index, and currency codes.
- local targets:
- local
- md: references/rippled-api/api-conventions/currency-formats.md - md: references/rippled-api/api-conventions/currency-formats.md
html: currency-formats.html html: currency-formats.html
@@ -996,62 +996,69 @@ pages:
doc_type: References doc_type: References
supercategory: rippled API supercategory: rippled API
category: API Conventions category: API Conventions
blurb: Precision and range for currency numbers, plus formats of custom currency codes.
targets: targets:
- local - local
- md: references/rippled-api/api-conventions/error-formatting.md - md: references/rippled-api/api-conventions/error-formatting.md
html: error-formatting.html html: error-formatting.html
funnel: Docs funnel: Docs
doc_type: References doc_type: References
supercategory: rippled API supercategory: rippled API
category: API Conventions category: API Conventions
targets: blurb: Error formats and common error codes for WebSocket, JSON-RPC, and Commandline interfaces.
- local targets:
- local
- md: references/rippled-api/api-conventions/markers-and-pagination.md - md: references/rippled-api/api-conventions/markers-and-pagination.md
html: markers-and-pagination.html html: markers-and-pagination.html
funnel: Docs funnel: Docs
doc_type: References doc_type: References
supercategory: rippled API supercategory: rippled API
category: API Conventions category: API Conventions
targets: blurb: Convention for paginating large queries into multiple responses.
- local targets:
- local
- md: references/rippled-api/api-conventions/modifying-the-ledger.md - md: references/rippled-api/api-conventions/modifying-the-ledger.md
html: modifying-the-ledger.html html: modifying-the-ledger.html
funnel: Docs funnel: Docs
doc_type: References doc_type: References
supercategory: rippled API supercategory: rippled API
category: API Conventions category: API Conventions
targets: blurb: Why and how only transactions can modify the ledger.
- local targets:
- local
- md: references/rippled-api/api-conventions/request-formatting.md - md: references/rippled-api/api-conventions/request-formatting.md
html: request-formatting.html html: request-formatting.html
funnel: Docs funnel: Docs
doc_type: References doc_type: References
supercategory: rippled API supercategory: rippled API
category: API Conventions category: API Conventions
targets: blurb: Standard request format, with examples, for the WebSocket, JSON-RPC, and Commandline interfaces.
- local targets:
- local
- md: references/rippled-api/api-conventions/response-formatting.md - md: references/rippled-api/api-conventions/response-formatting.md
html: response-formatting.html html: response-formatting.html
funnel: Docs funnel: Docs
doc_type: References doc_type: References
supercategory: rippled API supercategory: rippled API
category: API Conventions category: API Conventions
targets: blurb: Standard response format, with examples, for the WebSocket, JSON-RPC, and Commandline interfaces.
- local targets:
- local
- md: references/rippled-api/api-conventions/rippled-server-states.md - md: references/rippled-api/api-conventions/rippled-server-states.md
html: rippled-server-states.html html: rippled-server-states.html
funnel: Docs funnel: Docs
doc_type: References doc_type: References
supercategory: rippled API supercategory: rippled API
category: API Conventions category: API Conventions
targets: blurb: Definitions of state information reported in some API methods.
- local targets:
- local
# rippled Public Methods # rippled Public Methods