Skip to content

Commit 607798a

Browse files
committed
fix(docs): close light doc drift from review
- docs/README: drop dangling API Reference tracker, update status cells - docs/api-reference: specify 128-cap eviction/TTL/scope - entrypoint: printf for port return values
1 parent 32ed0b1 commit 607798a

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

‎docs/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Welcome to the OpenCode2API documentation.
2727
| 📄 [Main README](../README.md) | English canonical entrypoint |
2828
| 📄 [README (简体中文)](../README.zh-CN.md) | Simplified Chinese mirror of the main README |
2929

30-
Detailed endpoint diagnostics live with the configuration guide for now: `/health/details` and `/metrics` are specified in [Configuration](./configuration.md) and summarized in the [Main README](../README.md#api-reference). A dedicated section in [API Reference](./api-reference.md) is tracked below.
30+
Detailed endpoint diagnostics live with the configuration guide for now: `/health/details` and `/metrics` are specified in [Configuration](./configuration.md) and summarized in the [Main README](../README.md#api-reference).
3131

3232
---
3333

@@ -38,8 +38,8 @@ Docs are migrating to **English-first**: the root [`README.md`](../README.md) is
3838
| Guide | Current language | English version |
3939
|:------|:-----------------|:----------------|
4040
| Getting Started | 简体中文 | tracked |
41-
| Configuration | 简体中文 | tracked (canonical env names fixed; see `AGENTS.md` §4) |
42-
| API Reference | 简体中文 + EN examples | tracked (needs `/health/details` + `/metrics` sections) |
41+
| Configuration | 简体中文 | tracked (canonical env names documented; see `AGENTS.md` §4) |
42+
| API Reference | 简体中文 + EN examples | tracked (needs English canonical + dedicated `/health/details` + `/metrics` sections, currently in Configuration) |
4343
| Docker Deployment | 简体中文 | tracked |
4444
| Troubleshooting | 简体中文 | tracked (smallest, do first) |
4545
| Development | 简体中文 | tracked (dedupe with `CONTRIBUTING.md`) |

‎docs/api-reference.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ curl -X POST http://127.0.0.1:10000/v1/responses \
205205
}'
206206
```
207207

208-
非流式 `responses` 响应会在 `response.output` 中返回 `type: "function_call"` 项;流式模式会发送 function_call 生命周期和参数增量事件。`previous_response_id` 续写只保留最近 128 条工具调用元数据;`function_call_output` 的 `call_id` 不在 state 且无 `name` 时返回 400 `unknown_tool_call_id`。
208+
非流式 `responses` 响应会在 `response.output` 中返回 `type: "function_call"` 项;流式模式会发送 function_call 生命周期和参数增量事件。`previous_response_id` 续写只保留最近 128 条工具调用元数据(超出时丢弃最旧、保留最新;按 response ID 链作用域保存,内存态、30min TTL + 60s 清扫,重启动失);`function_call_output` 的 `call_id` 不在 state 且无 `name` 时返回 400 `unknown_tool_call_id`。
209209

210210
**服务端联网搜索(`web_search`):**
211211

‎entrypoint.sh‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ normalize_port() {
2525
local value="$2"
2626
local fallback="$3"
2727
if [[ "$value" =~ ^[0-9]+$ ]] && [ "$value" -ge 1 ] && [ "$value" -le 65535 ]; then
28-
echo "$value"
28+
printf '%s\n' "$value"
2929
return 0
3030
fi
3131
if [ -n "$value" ]; then
3232
echo "[Config] Warning: ${label}=\"${value}\" is not a valid port (1-65535); using ${fallback}" >&2
3333
fi
34-
echo "$fallback"
34+
printf '%s\n' "$fallback"
3535
}
3636

3737
PROXY_PORT=$(normalize_port "OPENCODE_PROXY_PORT" "${OPENCODE_PROXY_PORT:-}" "")

0 commit comments

Comments
 (0)