Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/public-networks/how-to/use-besu-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ 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`
mjsmike62 marked this conversation as resolved.
Show resolved Hide resolved
to pretty-print the output.

:::

The following sections provide information about JSON-RPC, RPC Pub/Sub, and GraphQL.

## Enable API access
Expand Down
64 changes: 32 additions & 32 deletions docs/public-networks/reference/cli/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-->
Expand Down Expand Up @@ -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-->
Expand Down