Skip to content

docs: add dedicated integration API reference - #1136

Merged
alick-liming merged 2 commits into
feat/channel-integration-api-docsfrom
codex/channel-integration-api-docs
Oct 27, 2026
Merged

alick-liming merged 2 commits into
feat/channel-integration-api-docsfrom
codex/channel-integration-api-docs

Conversation

@alick-liming

@alick-liming alick-liming commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Document all eight channel-owned dedicated integration management APIs, including request/response schemas, examples, App Key scopes, channel permissions, private-channel access, masked settings, key rotation, and concurrent-change errors.

Separate public and dedicated integrations in the bilingual API navigation and catalogs. Clarify the existing public integration page titles while preserving their operation IDs and URLs. Keep module specs, consolidated specs, API counts, and redirects synchronized.

Known plugin_type values can be used to create dedicated integrations directly. Type lookup is optional and requires Integrations Read permission.

Validation

  • python3 scripts/lint_openapi.py — all 12 spec files passed.
  • python3 scripts/api_path_redirects.py --check and git diff --check passed.
  • Verified identical new endpoint structures across languages and module/consolidated specs; every new endpoint appears once per language in navigation and catalog.
  • Simplification review, uncommitted review, and full-branch review passed.
  • Full-site mint validate reports 36 existing syntax warnings in unchanged integration MDX pages. An unmodified main archive reproduces the same 36 warnings.
  • Full-site mint broken-links stops at the same unchanged apimetrics.mdx syntax error on both main and this branch.
  • mint validate passed in an isolated API-reference preview containing the updated specs, navigation, and catalogs.

No documentation has been published by this PR.

@alick-liming
alick-liming marked this pull request as ready for review October 27, 2026 05:11
@alick-liming
alick-liming merged commit 4dbf6fa into feat/channel-integration-api-docs Oct 27, 2026
2 checks passed
@alick-liming
alick-liming deleted the codex/channel-integration-api-docs branch October 27, 2026 05:11
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