Skip to content

docs: 完整交付公开 API 指南示例与 OpenAPI - #72

Merged
yi-ge merged 6 commits into
mainfrom
codex/public-api-webhook-docs
Oct 15, 2026
Merged

yi-ge merged 6 commits into
mainfrom
codex/public-api-webhook-docs

Conversation

@yi-ge

@yi-ge yi-ge commented Oct 13, 2026 •

Copy link
Copy Markdown
Member

变更说明 / Description

完整交付“集成与 API”公开区域:8 组中英文页面,24 个经过筛选的 HTTP 操作,3 份自包含 OpenAPI 3.1 文件,可运行的 Node.js HTTP + Socket.IO 客户端及恢复/取消示例。

  • 连接认证、Webhook 配置/触发/轮换/交付、只读 Agent/Run/回执、对话、模型代理和独立 Workflow Service。
  • 独立导航/sidebar、首页与集成入口;明确实例地址与文档地址,以及三类服务各自凭据和结果方式。
  • Webhook 新管理先检查 webhookManagement 能力;旧服务只调用已配置事件。模型代理使用 Provider 绑定安全 token;Workflow 不虚构直接运行所需 grant 的签发流程。
  • 维护清单与离线检查核对双语 slug、版本范围、JSON、规范操作/鉴权/引用、canonical/hreflang/sitemap及静态下载字节。

Deliver the complete selected public API area with bilingual guides, 24 HTTP operations across three independent services, self-contained OpenAPI downloads, and a runnable Node HTTP/Socket.IO conversation client. Preserve actual authorization, asynchronous completion, bounded retry/recovery, credential lifetimes and deployment boundaries; no speculative endpoints or fabricated release versions.

依赖已满足 / Dependency resolved: desirecore/desirecore#4798 passed all CI checks and merged as e45f22902af2dc45b109cfa8f454795538aea2ed. Final source comparison confirms the selected 24 endpoint contracts are unchanged; catalog/spec provenance is pinned to that merge. Internal contracts and inventory were calibrated separately; API user pages contain observable support conditions, rather than private branch/PR gates.

测试方式 / Test Plan

  • pnpm typecheck, bilingual pnpm build, pnpm api:check -- --build: passed.
  • Catalog: 8 bilingual pages / 24 endpoints / 44 JSON code blocks / 3 specs.
  • Redocly CLI 2.63.0: all 3 specs have zero errors; AS retains 47 existing conditional-Schema warnings. AJV Draft07: 51 schemas and 34 media examples passed.
  • Fixed source snapshots: 122 focused unit/integration cases (118 original + 4 metadata assertions); separate Node client 12 contract cases; proxy token/protocol tests 15 + 18. Model upstreams and query callbacks are synthetic as documented, not commercial-provider or packaged-client acceptance.
  • Browser: 1440/1280/1024/375 widths, six main/new API pages with no document overflow; locale switch retains conversation page. Copy feedback succeeded, clipboard text was not exposed by the browser.
  • No general Webhook idempotency, per-request Run result, automatic final-answer delivery, model-level token quota, or complete tool audit claim.

检查清单 / Checklist

最终发布核对 / Publication preflight

2026-10-15: rebased onto current docs main fed87a6, preserving the three editions’ release notes. Site typecheck, bilingual production build and offline built-route/download verification passed. Source #4793 and #4798 are already merged with successful gates; this PR now proceeds to automatic deployment and production acceptance.

@vercel

vercel Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Oct 15, 2026 8:50am UTC

Request Review

Comment thread scripts/check-api-docs.mjs Fixed
@yi-ge
yi-ge force-pushed the codex/public-api-webhook-docs branch from e9d83f1 to 8f80838 Compare October 15, 2026 08:48
@yi-ge
yi-ge merged commit 93fcbd2 into main Oct 15, 2026
7 checks passed
@yi-ge
yi-ge deleted the codex/public-api-webhook-docs branch October 15, 2026 08:51

This branch was successfully deployed

1 active deployment
Preview — 8f808384 Deployed Oct 15, 2026 by vercel[bot]
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.

2 participants