Skip to content

docs: generate Chats API docs from swagger annotations #24830

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
david-fraley merged 11 commits into from
May 5, 2026
Merged

docs: generate Chats API docs from swagger annotations #24830

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
0a267f9
docs(coderd/exp_chats): generate API docs from swagger annotations
david-fraley Apr 29, 2026
5b61272
docs: also annotate chat WebSocket endpoints
david-fraley Apr 29, 2026
5b43786
docs: mark Chats API endpoints as experimental
david-fraley Apr 29, 2026
a631825
docs(coderd/exp_chats.go): annotate List chat models endpoint
david-fraley Apr 30, 2026
44069db
fix(AGENTS.md): remove directive re swagger annotations in exp_chats.go
johnstcn May 1, 2026
f8111ca
docs(coderd/exp_chats.go): fix swagger annotations
johnstcn May 1, 2026
c9f5472
docs(docs/manifest.json): keep Chats API state as early access
david-fraley May 1, 2026
097c4ae
fix: resolve merge conflicts with main
david-fraley May 5, 2026
341f58a
fix(docs): retarget broken chats-api link in best-practices.md
david-fraley May 5, 2026
844e8b3
fix: resolve merge conflict in docs/manifest.json
david-fraley May 5, 2026
d69831d
fix: remove stale chats-api.md manifest entry, fix table formatting
david-fraley May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fix: remove stale chats-api.md manifest entry, fix table formatting 
The merge from main re-introduced the chats-api.md manifest entry
that this PR originally removed. Also fix trailing whitespace in
best-practices.md markdown table.
  • Loading branch information
@david-fraley
david-fraley committed May 5, 2026
commit d69831deef73ce3242ce44bc66b3418346bfcf6b
2 changes: 1 addition & 1 deletion docs/ai-coder/best-practices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Below are common scenarios where AI coding agents provide the most impact, along
| **Automating actions in the IDE** | Supplement tedious development with agents | Small refactors, generating unit tests, writing inline documentation, code search and navigation | [IDE Agents](./ide-agents.md) in Workspaces |
| **Developer-led investigation and setup** | Developers delegate research and initial implementation to AI, then take over in their preferred IDE to complete the work | Bug triage and analysis, exploring technical approaches, understanding legacy code, creating starter implementations | [Coder Agents](./agents/index.md), to a full IDE with [Workspaces](../user-guides/workspace-access/index.md) |
| **Prototyping & Business Applications** | User-friendly interface for engineers and non-technical users to build and prototype within new or existing codebases | Creating dashboards, building simple web apps, data analysis workflows, proof-of-concept development | [Coder Agents](./agents/index.md) |
| **Full background jobs & long-running agents** | Agents that run independently without user interaction for extended periods of time | Automated code reviews, scheduled data processing, continuous integration tasks, monitoring and alerting | [Coder Agents API](../reference/api/chats.md) |
| **Full background jobs & long-running agents** | Agents that run independently without user interaction for extended periods of time | Automated code reviews, scheduled data processing, continuous integration tasks, monitoring and alerting | [Coder Agents API](../reference/api/chats.md) |
| **External agents and chat clients** | External AI agents and chat clients that need access to Coder workspaces for development environments and code sandboxing | ChatGPT, Claude Desktop, custom enterprise agents running tests, performing development tasks, code analysis | [MCP Server](./mcp-server.md) |

## Provide Agents with Proper Context
Expand Down
6 changes: 0 additions & 6 deletions docs/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1063,12 +1063,6 @@
"path": "./ai-coder/agents/extending-agents.md",
"state": ["beta"]
},
{
"title": "Chats API",
"description": "Programmatic access to Coder Agents via the Chats API",
"path": "./ai-coder/agents/chats-api.md",
"state": ["beta"]
},
{
"title": "Tasks to Chats API Migration",
"description": "Guide for migrating from the Tasks API to the Chats API",
Expand Down
Loading