Merge pull request #2130 from XRPLF/server_info_ports

server_info/state: document new ports field
This commit is contained in:
Rome Reginelli
2023-09-14 16:11:58 -07:00
committed by GitHub
7 changed files with 225 additions and 211 deletions

View File

@@ -0,0 +1,11 @@
### Port Descriptor Object
<!-- This nested object definition is identical across server_state and server_info -->
Each member of the `ports` array is an object with the following fields:
| Field | Value | Description |
|------------|-----------------|-------------|
| `port` | String - Number | A port number where the server is listening. |
| `protocol` | Array of String | A list of protocols being served on this port. Valid protocols include `http` or `https` for JSON-RPC, `ws`, `ws2`, `wss`, `wss2` for WebSocket, `grpc` for [gRPC](configure-grpc.html), and `peer` for the [XRP Ledger Peer Protocol](peer-protocol.html). |
**Note:** Depending on network infrastructure, the ports and protocols reported here may not match how the server can be reached from the outside network. For example, if TLS terminates at a load balancer or proxy, the server may report `http` on one port, but might only be reachable through `https` on port 443 from outside.

View File

@@ -43,6 +43,7 @@
"1.8.1",
"1.10.0",
"1.11.0",
"1.12.0",
] %}
{% for v in rippled_versions %}