Moved--json-pretty-print-enabled CLI option & created note (#1407)

* Moved--json-pretty-print-enabled CLI option & created note Signed-off-by: Mike Sanko <mike.sanko@consensys.net> * Updated note w/xref Signed-off-by: Mike Sanko <mike.sanko@consensys.net> --------- Signed-off-by: Mike Sanko <mike.sanko@consensys.net>
hyperledger · Sep 29, 2023 · 029faa4 · 029faa4
1 parent 350591e
commit 029faa4
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 32 deletions.
diff --git a/docs/public-networks/how-to/use-besu-api/index.md b/docs/public-networks/how-to/use-besu-api/index.md
@@ -13,6 +13,12 @@ Access the [Hyperledger Besu API](../../reference/api/index.md) using:
 - [RPC Pub/Sub over WebSockets](rpc-pubsub.md)
 - [GraphQL over HTTP](graphql.md).
 
+:::note
+
+HTTP and WebSocket responses are compact JSON by default. You can use [`--json-pretty-print-enabled`](../../reference/cli/options.md#json-pretty-print-enabled) to pretty-print the output.
+
+:::
+
 The following sections provide information about JSON-RPC, RPC Pub/Sub, and GraphQL.
 
 ## Enable API access

diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md
@@ -1101,6 +1101,38 @@ The name for the node. If specified, it's the second section of the client ID pr
 
 If a name is not specified, the name section is not included in the client ID. For example, `besu/v1.3.4/linux-x86_64/oracle_openjdk-java-11`.
 
+### `json-pretty-print-enabled`
+
+<!--tabs-->
+
+# Syntax
+
+```bash
+--json-pretty-print-enabled[=<true|false>]
+```
+
+# Example
+
+```bash
+--json-pretty-print-enabled=true
+```
+
+# Environment variable
+
+```bash
+BESU_JSON_PRETTY_PRINT_ENABLED=true
+```
+
+# Configuration file
+
+```bash
+json-pretty-print-enabled=true
+```
+
+<!--/tabs-->
+
+Enables or disables the pretty-print output for HTTP and WebSocket responses. The default is `false`.
+
 ### `key-value-storage`
 
 <!--tabs-->
@@ -3531,38 +3563,6 @@ rpc-ws-port="6174"
 
 The port (TCP) on which WebSocket JSON-RPC listens. The default is `8546`. You must [expose ports appropriately](../../how-to/connect/configure-ports.md).
 
-### `json-pretty-print-enabled`
-
-<!--tabs-->
-
-# Syntax
-
-```bash
---json-pretty-print-enabled[=<true|false>]
-```
-
-# Example
-
-```bash
---json-pretty-print-enabled=true
-```
-
-# Environment variable
-
-```bash
-BESU_JSON_PRETTY_PRINT_ENABLED=true
-```
-
-# Configuration file
-
-```bash
-json-pretty-print-enabled=true
-```
-
-<!--/tabs-->
-
-Enables or disables the pretty-print output for HTTP and WebSocket responses. The default is `false`.
-
 ### `security-module`
 
 <!--tabs-->