Record API curl examples in growth tracker (#3369)

Co-authored-by: LauraGPT <[email protected]>
This commit is contained in:
zhifu gao
2026-07-23 06:40:23 +08:00
committed by GitHub
co-authored by LauraGPT
parent dbfbc3ccaf
commit ff95b36565
2 changed files with 23 additions and 1 deletions
+1 -1
View File
@@ -349,7 +349,7 @@ Paste the Markdown output into launch notes, weekly community updates, or releas
### Week 2: Deployment proof
- [ ] Publish API server curl examples.
- [x] Publish API server curl examples. On 2026-07-23, the OpenAI-compatible API docs already publish copy-paste curl paths in `examples/openai_api/README.md` and `examples/openai_api/README_zh.md`, plus scripted smoke tests in `examples/openai_api/smoke_test.sh` and `examples/openai_api/smoke_test.py`. The manual flow downloads `sample.wav`, checks `/health`, and posts to `/v1/audio/transcriptions` with `-F [email protected]`, `-F model=sensevoice`, and `response_format=verbose_json`; no-code and gateway users can use `examples/openai_api/POSTMAN.md` and `examples/openai_api/OPENAPI.md`.
- [ ] Publish WebSocket streaming examples.
- [ ] Validate Docker CPU and GPU images.
- [ ] Validate vLLM guide on one GPU server.
+22
View File
@@ -56,3 +56,25 @@ def test_growth_plan_records_github_metadata_completion():
assert marker in text
assert "[ ] Confirm GitHub repo description and topics mention ASR" not in text
def test_growth_plan_records_api_curl_examples_completion():
text = PLAN.read_text()
required_markers = [
"[x] Publish API server curl examples",
"`examples/openai_api/README.md`",
"`examples/openai_api/README_zh.md`",
"`examples/openai_api/smoke_test.sh`",
"`examples/openai_api/smoke_test.py`",
"`/v1/audio/transcriptions`",
"`-F [email protected]`",
"`-F model=sensevoice`",
"`response_format=verbose_json`",
"`examples/openai_api/POSTMAN.md`",
"`examples/openai_api/OPENAPI.md`",
]
for marker in required_markers:
assert marker in text
assert "[ ] Publish API server curl examples" not in text