From e335ce4da6af40c92dc28dfcfef727a3a5f33fa1 Mon Sep 17 00:00:00 2001 From: NanamiAdmin Date: Mon, 23 Mar 2026 22:14:04 +0800 Subject: [PATCH] docs(api): update field names to use camelCase in API documentation --- docs/api.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/api.md b/docs/api.md index 65ac324..4830124 100644 --- a/docs/api.md +++ b/docs/api.md @@ -826,16 +826,16 @@ X-Timestamp: 1704067200000 { "name": "ssh_proxy", "type": "tcp", - "local_ip": "127.0.0.1", - "local_port": "22", - "remote_port": "6000" + "localIP": "127.0.0.1", + "localPort": "22", + "remotePort": "6000" }, { "name": "web_proxy", "type": "http", - "local_ip": "127.0.0.1", - "local_port": "8080", - "remote_port": "80" + "localIP": "127.0.0.1", + "localPort": "8080", + "remotePort": "80" } ] } @@ -854,9 +854,9 @@ X-Timestamp: 1704067200000 |-------|------|-------------| | name | string | Proxy name | | type | string | Proxy type (e.g., tcp, udp, http, https) | -| local_ip | string | Local IP address to forward to | -| local_port | string | Local port to forward from | -| remote_port | string | Remote port on frps to expose | +| localIP | string | Local IP address to forward to | +| localPort | string | Local port to forward from | +| remotePort | string | Remote port on frps to expose | > **Note:** > - The proxy configurations are read from the existing config file