docs: complete swagger annotations for organization-scoped MCP routes - #28064
docs: complete swagger annotations for organization-scoped MCP routes#28064ibetitsmike wants to merge 1 commit into
Conversation
Docs previewCheck off each page once it's been reviewed. If a page changes in a later push, its checkbox clears automatically so it gets a fresh look. Pages not yet wired into the docs navigation aren't listed here. |
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 70c1ad844f
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| "title": "MCP", | ||
| "path": "./reference/api/mcp.md" |
There was a problem hiding this comment.
Do not publish an empty MCP API page
Every MCP operation introduced here has x-apidocgen.skip set, so the generated mcp.md contains only # MCP; nevertheless, this entry adds that empty page to the public REST API navigation. Users who select MCP therefore land on a page with no endpoint documentation. Omit sections whose operations are all skipped, or otherwise keep this manifest entry out until at least one MCP operation is publishable.
Useful? React with 👍 / 👎.
70c1ad8 to
f84f73c
Compare
|
@codex review |
|
Codex Review: Didn't find any major issues. Bravo. Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Adds the missing swagger annotations for the eight organization-scoped MCP server config routes introduced in #27942 and checks in the regenerated API artifacts (
coderd/apidoc,docs/reference/api). No behavior changes: 58 hand-written annotation lines, the rest is generated output.Stack context
Part of the MCP org-separation stack (CODAGT-711 org scope -> apidocs -> hardening -> CODAGT-717 audit -> CODAGT-712 ACLs -> CODAGT-806 token RBAC). Split out of #27942 to keep the core cutover reviewable; these routes live under
/api/experimental, where main already ships several MCP handlers without annotations, so the base PR is consistent with existing precedent until this lands.Closes nothing on its own; documentation completion for CODAGT-711.