Skip to content

docs(api): align public integration contracts with datasource #556 - #1028

Merged
alick-liming merged 3 commits into
feat/public-integration-frontend-docsfrom
codex/public-integration-contract-docs-20261009
Oct 10, 2026
Merged

alick-liming merged 3 commits into
feat/public-integration-frontend-docsfrom
codex/public-integration-contract-docs-20261009

Conversation

@alick-liming

Copy link
Copy Markdown
Contributor

Summary

  • 基于最新 main,按 fc-datasource docs(stripe): current Workbench labels and test paths #556(b90a966)及前端 #1203 的公共集成迁移同步中英文文档。
  • 补齐列表中的 settings、解密 integration_key、plugin_id、account_id、旧 ID 别名及编辑权限字段;详情同步配置、Key 和可选测试结果。
  • 去除旧的“敏感字段脱敏”“Key 仅返回一次”说明;补充创建 Key 约束、插件测试、配置更新、Key 轮换、对象权限及公共/专属集成边界。
  • 修正 IntegrationDetail 内错误的 schema 数组结构,更新对应请求/响应示例。

Validation

  • python3 scripts/lint_openapi.py:12 份规范通过。
  • python3 scripts/api_path_redirects.py --check:通过。
  • mint broken-links:无坏链接。
  • git diff --check:通过。
  • 契约校验:9 条 API、6 个 schema,中英文与分模块/总文档一致,72 组请求/响应示例通过。
  • 范围校验:其他路径、schema、全局配置均未变;独立文档阅读复核通过。

Scope / Notes

  • 只修改 4 份 OpenAPI 文档及 2 份中英文 API 目录说明,没有修改导航或其他模块。
  • 示例为按源码构造的虚拟数据,未执行生产 API、数据库写入或部署。
  • PR 目标为独立 feat 分支;不合入 main,由 Boss 安排发布合入。

@alick-liming
alick-liming marked this pull request as ready for review October 10, 2026 05:47
@alick-liming
alick-liming merged commit 397d520 into feat/public-integration-frontend-docs Oct 10, 2026
2 checks passed
@alick-liming
alick-liming deleted the codex/public-integration-contract-docs-20261009 branch October 10, 2026 05:47
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