Repository navigation
docs: add dedicated integration API reference - #1136
Merged
alick-liming merged 2 commits intoOct 27, 2026
Merged
alick-liming merged 2 commits into
alick-liming merged 2 commits into
Conversation
alick-liming
marked this pull request as ready for review
October 27, 2026 05:11
alick-liming
merged commit Oct 27, 2026
4dbf6fa
into
feat/channel-integration-api-docs
2 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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_typevalues 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 --checkandgit diff --checkpassed.mint validatereports 36 existing syntax warnings in unchanged integration MDX pages. An unmodified main archive reproduces the same 36 warnings.mint broken-linksstops at the same unchangedapimetrics.mdxsyntax error on both main and this branch.mint validatepassed in an isolated API-reference preview containing the updated specs, navigation, and catalogs.No documentation has been published by this PR.