Skip to content

Commit 9beac57

Browse files
AnnaR-progclaude
authored andcommitted
docs(config): list graphql as an api-interface (MAG-2863)
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
1 parent 26cf2e0 commit 9beac57

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

‎docs/configuration/config-file.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Each entry opens one listening socket for one chain + interface.
6969
| --- | --- | --- |
7070
| `network-address` | yes | `host:port` to listen on, e.g. `0.0.0.0:3360`. |
7171
| `chain-id` | yes | Spec chain id (`ETH1`, `SOLANA`, `COSMOSHUB`, …). Must resolve from `--use-static-spec`. |
72-
| `api-interface` | yes | `jsonrpc`, `rest`, `grpc`, or `tendermintrpc` — must be supported by the chain spec. |
72+
| `api-interface` | yes | `jsonrpc`, `rest`, `grpc`, `tendermintrpc`, or `graphql` — must be supported by the chain spec. A `graphql` listener accepts HTTP `POST` only (any path; other methods get `405`) and serves no subscriptions. |
7373
| `tls-enabled` | no | Serve this listener over TLS using a self-signed certificate. Default `false`. |
7474
| `health-check-path` | no | HTTP path that returns `200` for liveness probes. Default `/lava/health`. |
7575

@@ -110,7 +110,7 @@ direct-rpc:
110110

111111
| Field | Description |
112112
| --- | --- |
113-
| `url` | Connection URL. Schemes: `http(s)://`, `ws(s)://`, `grpc(s)://`. A `jsonrpc` backend on an ETH1-derived spec needs a paired `wss://` url. |
113+
| `url` | Connection URL. Schemes: `http(s)://`, `ws(s)://`, `grpc(s)://`. A `jsonrpc` backend on an ETH1-derived spec needs a paired `wss://` url. A `graphql` backend's url is the full GraphQL endpoint, path included (e.g. `https://graphql.mainnet.sui.io/graphql`): the router POSTs to it as-is. |
114114
| `timeout` | Per-URL request timeout, e.g. `10s`. Defaults to the spec value. |
115115
| `addons` | Add-ons this URL serves, e.g. `["archive", "debug"]`. The router only routes matching methods here. |
116116
| `methods` | Restrict this URL to a specific method list. When set, only those methods route here. |

‎docs/reference/chains/specs.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ spec file the router loads at startup.
1717

1818
| Part | What it's for |
1919
| --- | --- |
20-
| **API methods** | Every RPC method the chain exposes, per interface (`jsonrpc` / `rest` / `grpc` / `tendermintrpc`). |
20+
| **API methods** | Every RPC method the chain exposes, per interface (`jsonrpc` / `rest` / `grpc` / `tendermintrpc` / `graphql`). |
2121
| **Parser rules** | How to read a method's request/response — e.g. which param holds the block number — so the router can cache, route, and apply [consistency](../../configuration/failover/integrity.md) correctly. |
2222
| **Categories** | Per-method flags: read vs. write (stateful), whether it's cacheable, which addon/extension it needs (archive, debug). These drive [node selection](../../configuration/projects/selection-policies.md) and caching. |
2323
| **Finality parameters** | Block times and finalization distance — feed the integrity lag gate and finalized-vs-not cache TTLs. |

‎docs/reference/metrics.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ The flag name and the `disabled` sentinel live in
140140
- **Attempt histograms** (`retry_attempts`, `hedge_attempts`) use integer buckets `1…10`.
141141
- **Common labels**:
142142
- `spec` — chain spec id (e.g. `ETH1`, `LAV1`).
143-
- `apiInterface` — `jsonrpc`, `tendermintrpc`, `rest`, `grpc`.
143+
- `apiInterface` — `jsonrpc`, `tendermintrpc`, `rest`, `grpc`, `graphql`.
144144
- `endpoint_id` — the configured upstream RPC endpoint.
145145
- `provider_address` — node the relay was routed to.
146146
- `method` — RPC method name. Batch requests carry a

0 commit comments

Comments
 (0)