docs: Minor recommendations prior to v0.34.21 release (#9267)

* Make reindex-event cmd docs consistent with other commands Signed-off-by: Thane Thomson <connect@thanethomson.com> * Add warning regarding DiscardABCIResponses to BlockResults Go API Signed-off-by: Thane Thomson <connect@thanethomson.com> * Update OpenAPI spec to reflect discard_abci_responses change Signed-off-by: Thane Thomson <connect@thanethomson.com> * Add release highlights to CHANGELOG_PENDING Signed-off-by: Thane Thomson <connect@thanethomson.com> * Add pending changelog entry for #9033 Signed-off-by: Thane Thomson <connect@thanethomson.com> * Format pending changelog entries consistently Signed-off-by: Thane Thomson <connect@thanethomson.com> * Correct and simplify comment wording Signed-off-by: Thane Thomson <connect@thanethomson.com> * Remove changelog entry regarding storage section Signed-off-by: Thane Thomson <connect@thanethomson.com> Signed-off-by: Thane Thomson <connect@thanethomson.com> Co-authored-by: Thane Thomson <connect@thanethomson.com>
Finschia · Jul 19, 2023 · a6b7895 · a6b7895
1 parent 56c0b62
commit a6b7895
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/cmd/ostracon/commands/reindex_event.go b/cmd/ostracon/commands/reindex_event.go
@@ -33,10 +33,10 @@ var (
 // ReIndexEventCmd constructs a command to re-index events in a block height interval.
 var ReIndexEventCmd = &cobra.Command{
 	Use:   "reindex-event",
-	Short: "reindex events to the event store backends",
+	Short: "Re-index events to the event store backends",
 	Long: `
-reindex-event is an offline tooling to re-index block and tx events to the eventsinks,
-you can run this command when the event store backend dropped/disconnected or you want to
+reindex-event is an offline tooling to re-index block and tx events to the eventsinks.
+You can run this command when the event store backend dropped/disconnected or you want to
 replace the backend. The default start-height is 0, meaning the tooling will start
 reindex from the base block height(inclusive); and the default end-height is 0, meaning
 the tooling will reindex until the latest block height(inclusive). User can omit

diff --git a/rpc/core/blocks.go b/rpc/core/blocks.go
@@ -133,6 +133,7 @@ func Commit(ctx *rpctypes.Context, heightPtr *int64) (*ctypes.ResultCommit, erro
 
 // BlockResults gets ABCIResults at a given height.
 // If no height is provided, it will fetch results for the latest block.
+// When DiscardABCIResponses is enabled, an error will be returned.
 //
 // Results are for the height of the block containing the txs.
 // Thus response.results.deliver_tx[5] is the results of executing

diff --git a/rpc/openapi/openapi.yaml b/rpc/openapi/openapi.yaml
@@ -708,7 +708,8 @@ paths:
       tags:
         - Info
       description: |
-        Get block_results.
+        Get block_results. When the `discard_abci_responses` storage flag is
+        enabled, this endpoint will return an error.
       responses:
         "200":
           description: Block results.