docs: update /rest/chaininfo doc referring to RPC help #24776
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
|
Concept ACK. Though, if it's the same, at some point we might as well say 'see |
Contributor
Author
I agree For Line 132 in d2e0419 Should we follow this pattern for other endpoints to avoid out of date fields? If so, I can use this PR to remove it and add |
Member
|
Concept ACK.
Agree, and it looks like getblockchaininfo will be updated soon for a deprecation. Maybe something like the following diff: diff
diff --git a/doc/REST-interface.md b/doc/REST-interface.md
index c359725faf..f11624fd28 100644
--- a/doc/REST-interface.md
+++ b/doc/REST-interface.md
@@ -82,17 +82,7 @@ Given a height: returns hash of block in best-block-chain at height provided.
Returns various state info regarding block chain processing.
Only supports JSON as output format.
-* chain : (string) current network name (main, test, signet, regtest)
-* blocks : (numeric) the current number of blocks processed in the server
-* headers : (numeric) the current number of headers we have validated
-* bestblockhash : (string) the hash of the currently best block
-* difficulty : (numeric) the current difficulty
-* mediantime : (numeric) the median time of the 11 blocks before the most recent block on the blockchain
-* verificationprogress : (numeric) estimate of verification progress [0..1]
-* chainwork : (string) total amount of work in active chain, in hexadecimal
-* pruned : (boolean) if the blocks are subject to pruning
-* pruneheight : (numeric) highest block available
-* softforks : (array) status of softforks in progress
+Refer to the `getblockchaininfo` RPC help for details.
#### Query UTXO set
`GET /rest/getutxos/<checkmempool>/<txid>-<n>/<txid>-<n>/.../<txid>-<n>.<bin|hex|json>`
@@ -127,13 +117,13 @@ $ curl localhost:18332/rest/getutxos/checkmempool/b2cdfd7b89def827ff8af7cd9bff76
#### Memory pool
`GET /rest/mempool/info.json`
-Returns various information about the TX mempool.
+Returns various information about the transaction mempool.
Only supports JSON as output format.
-Refer to the `getmempoolinfo` RPC for documentation of the fields.
+Refer to the `getmempoolinfo` RPC help for details.
`GET /rest/mempool/contents.json`
-Returns transactions in the TX mempool.
+Returns the transactions in the mempool.
Only supports JSON as output format. |
brunoerg
force-pushed
the
2022-04-rest-doc-improv
branch
from
cff4fb3 to
1d95b5c
Compare
brunoerg
changed the title
/rest/chaininfo doc according to getblockchaininfo
Contributor
Author
jonatack
approved these changes
Apr 19, 2022
sidhujag
pushed a commit
to syscoin/syscoin
that referenced
this pull request
Apr 19, 2022
luke-jr
pushed a commit
to luke-jr/bitcoin
that referenced
this pull request
May 21, 2022
Github-Pull: bitcoin#24776 Rebased-From: b941dec
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Internally,
/rest/chaininfogets the infos fromgetblockchaininfoand I just realized the documentation of it inREST-interface.mdis outdated compared to thegetblockchaininfoRPC one. This PR removes the documentation of the fields and adds a reference to the RPC help.