From a8446801655b9d4bf77fbd0f565ff2595c930968 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Mon, 22 May 2017 15:37:07 -0700 Subject: [PATCH] rippled: error code phrasing cleanups --- content/reference-rippled.md | 16 ++++++++-------- reference-rippled.html | 16 ++++++++-------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/content/reference-rippled.md b/content/reference-rippled.md index f2a090653f..8d59f89297 100755 --- a/content/reference-rippled.md +++ b/content/reference-rippled.md @@ -7985,9 +7985,9 @@ The response follows the [standard format](#response-formatting), with a success * Any of the [universal error types](#universal-errors). * `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. -* `publicMalformed` - The value specified in the `public_key` field of the request was not a valid public key in the correct format. Public keys are 33 bytes and must be represented in base58. The base58 representation of account public keys starts with the letter `a`. -* `channelMalformed` - The value specified in the `channel_id` field of the reqeuest was not a valid Channel ID. The Channel ID should be a 256-bit (64-character) hexadecimal string. -* `channelAmtMalformed` - The value specified in the `amount` field was not a valid XRP amount. See [Specifying Currency Amounts](#specifying-currency-amounts) for details. +* `publicMalformed` - The `public_key` field of the request is not a valid public key in the correct format. Public keys are 33 bytes and must be represented in base58. The base58 representation of account public keys starts with the letter `a`. +* `channelMalformed` - The `channel_id` field of the request is not a valid Channel ID. The Channel ID must be a 256-bit (64-character) hexadecimal string. +* `channelAmtMalformed` - The value specified in the `amount` field was not a valid [XRP amount](#specifying-currency-amounts). @@ -8119,8 +8119,8 @@ The response follows the [standard format](#response-formatting). The fields con * Any of the [universal error types](#universal-errors). * `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. * `noPermission` - The request included the `url` field, but you are not connected as an admin. -* `unknownStream` - One or more the members of the `streams` field in the request was not recognized as a valid stream name. -* `malformedStream` - The `streams` field of the request was not formatted properly. +* `unknownStream` - One or more the members of the `streams` field of the request is not a valid stream name. +* `malformedStream` - The `streams` field of the request is not formatted properly. * `malformedAccount` - One of the addresses in the `accounts` or `accounts_proposed` fields of the request is not a properly-formatted Ripple address. (**Note:**: You _can_ subscribe to the stream of an address that does not yet have an entry in the global ledger to get a message when that address becomes funded.) * `srcCurMalformed` - One or more `taker_pays` sub-fields of the `books` field in the request is not formatted properly. * `dstAmtMalformed` - One or more `taker_gets` sub-fields of the `books` field in the request is not formatted properly. @@ -8616,7 +8616,7 @@ The response follows the [standard format](#response-formatting), with a success * Any of the [universal error types](#universal-errors). * `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. * `noPermission` - The request included the `url` field, but you are not connected as an admin. -* `malformedStream` - The `streams` field of the request was not formatted properly. +* `malformedStream` - The `streams` field of the request is not formatted properly. * `malformedAccount` - One of the addresses in the `accounts` or `accounts_proposed` fields of the request is not a properly-formatted Ripple address. * **Note:**: You _can_ subscribe to the stream of an address that does not yet have an entry in the global ledger to get a message when that address becomes funded. * `srcCurMalformed` - One or more `taker_pays` sub-fields of the `books` field in the request is not formatted properly. @@ -10207,7 +10207,7 @@ For most other entries, the value indicates the number of objects of that type c ## ledger_cleaner ## [[Source]
](https://github.com/ripple/rippled/blob/df54b47cd0957a31837493cd69e4d9aade0b5055/src/ripple/rpc/handlers/LedgerCleaner.cpp "Source") -The `ledger_cleaner` command controls the [Ledger Cleaner](https://github.com/ripple/rippled/blob/f313caaa73b0ac89e793195dcc2a5001786f916f/src/ripple/app/ledger/README.md#the-ledger-cleaner), an asynchronous maintenance process that can find and repair corruption in rippled's database of ledgers. +The `ledger_cleaner` command controls the [Ledger Cleaner](https://github.com/ripple/rippled/blob/f313caaa73b0ac89e793195dcc2a5001786f916f/src/ripple/app/ledger/README.md#the-ledger-cleaner), an asynchronous maintenance process that can find and repair corruption in `rippled`'s database of ledgers. _The `ledger_cleaner` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._ @@ -10271,7 +10271,7 @@ The response follows the [standard format](#response-formatting), with a success #### Possible Errors #### * Any of the [universal error types](#universal-errors). -* `internal` if one the parameters was specified in a way that the server couldn't interpret. (This is a bug, and it should return `invalidParams` instead.) +* `internal` if one the parameters is specified incorrectly. (This is a bug; the intended error code is `invalidParams`.) ## log_level ## diff --git a/reference-rippled.html b/reference-rippled.html index 59a5c43f87..c00c9133d8 100644 --- a/reference-rippled.html +++ b/reference-rippled.html @@ -9307,9 +9307,9 @@ rippled channel_verify aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3 5DB0

Subscriptions

Using subscriptions, you can have the server push updates to your client when various events happen, so that you can know and react right away. Subscriptions are only supported in the WebSocket API, where you can receive additional responses in the same channel.

@@ -9474,8 +9474,8 @@ rippled channel_verify aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3 5DB0
  • Any of the universal error types.
  • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
  • noPermission - The request included the url field, but you are not connected as an admin.
    • -
  • unknownStream - One or more the members of the streams field in the request was not recognized as a valid stream name.
    • -
  • malformedStream - The streams field of the request was not formatted properly.
    • +
  • unknownStream - One or more the members of the streams field of the request is not a valid stream name.
    • +
  • malformedStream - The streams field of the request is not formatted properly.
  • malformedAccount - One of the addresses in the accounts or accounts_proposed fields of the request is not a properly-formatted Ripple address. (Note:: You can subscribe to the stream of an address that does not yet have an entry in the global ledger to get a message when that address becomes funded.)
  • srcCurMalformed - One or more taker_pays sub-fields of the books field in the request is not formatted properly.
  • dstAmtMalformed - One or more taker_gets sub-fields of the books field in the request is not formatted properly.
    • @@ -10179,7 +10179,7 @@ rippled channel_verify aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3 5DB0
  • Any of the universal error types.
  • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
  • noPermission - The request included the url field, but you are not connected as an admin.
    • -
  • malformedStream - The streams field of the request was not formatted properly.
    • +
  • malformedStream - The streams field of the request is not formatted properly.
  • malformedAccount - One of the addresses in the accounts or accounts_proposed fields of the request is not a properly-formatted Ripple address. @@ -12041,7 +12041,7 @@ Connecting to 127.0.0.1:5005

    ledger_cleaner

    [Source]

    -

    The ledger_cleaner command controls the Ledger Cleaner, an asynchronous maintenance process that can find and repair corruption in rippled's database of ledgers.

    +

    The ledger_cleaner command controls the Ledger Cleaner, an asynchronous maintenance process that can find and repair corruption in rippled's database of ledgers.

    The ledger_cleaner method is an admin command that cannot be run by unprivileged users.

    Request Format

    An example of the request format:

    @@ -12136,7 +12136,7 @@ Connecting to 127.0.0.1:5005

    Possible Errors

    log_level

    [Source]