Repository navigation
docs(agents): align seven API groups with current contracts - #35
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 323feb03e3
ℹ️ 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".
| required: true | ||
| schema: { type: string } | ||
| description: MCP connection ID (`mcp_` prefix). | ||
| description: MCP connection ID (`mcp_` prefix), or builtin:sandbase for the built-in SandBase server. |
There was a problem hiding this comment.
Keep the built-in ID out of connection resource paths
MCPConnectionIdPath is used by the persisted connection CRUD and enable endpoints (/v1/mcp-connections/{connection_id} and /enable), but builtin:sandbase is only a sentinel accepted in an Agent's mcp_connections array and has no connection resource to read, replace, disable, or enable. Advertising it in this shared path parameter incorrectly tells OpenAPI consumers that those operations accept the built-in ID, leading to 404 requests; document it only on AgentMCPConnectionRef and keep this parameter limited to mcp_ IDs.
Useful? React with 👍 / 👎.
Changes
The public Agents platform documentation lagged behind the current API: Session workspace/artifact endpoints were missing, model overrides were absent from Service/Schedule updates, and Skill bindings were described as following the default at Session creation.
Validation
npm run validatepassed.895e535afb; all reported contract discrepancies resolved.git diff --checkpassed.Documentation-only: no runtime changes or database migrations. Production publication requested by the user; verify changed public pages and OpenAPI after deployment.