Skip to content

feat(codegen): sync developer_guides API docs to markdown and swagger#66

Merged
chyroc merged 1 commit into
mainfrom
feat/sync-developer-guides-docs
Feb 26, 2026
Merged

feat(codegen): sync developer_guides API docs to markdown and swagger#66
chyroc merged 1 commit into
mainfrom
feat/sync-developer-guides-docs

Conversation

@chyroc

@chyroc chyroc commented Feb 26, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add cmd/coze-api-doc-sync CLI entry to fetch docs from llms.txt section developer_guides
  • add internal/apidocsync parser and serializer to:
    • keep only API-like docs that can be serialized
    • write raw markdown into docs/api-markdown/<api>.md
    • generate OpenAPI YAML into docs/api-swagger/<api>.yaml
  • add tests for section parsing, API doc parsing, websocket handling, swagger generation, and end-to-end sync flow
  • generate and commit current documentation snapshot
    • candidates: 183
    • generated: 126
    • skipped: 57

Validation

  • ./scripts/fmt.sh
  • ./scripts/lint.sh
  • ./scripts/test.sh (Total coverage: 82.6%)
  • ./scripts/build.sh
  • go run ./cmd/coze-api-doc-sync --output-root docs

@chyroc chyroc merged commit 8675d42 into main Feb 26, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant