Repository navigation
docs: describe the AI Providers API operations and parameters - #31530
Closed
nickvigilante wants to merge 1 commit into
Closed
nickvigilante wants to merge 1 commit into
nickvigilante wants to merge 1 commit into
Conversation
The REST API reference renders these routes from swagger.json, and they had no description. This adds descriptions and fuller parameter text for the five AI provider routes. Part of DOCS-1439. Assisted-by: AI
This was referenced Oct 29, 2026
Collaborator
Author
|
Combined into #31562, where this PR's changes are the commit Generated by Coder Agents on behalf of @nickvigilante. |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Adds
@Descriptiontext to the five AI provider routes that had none, and replaces the path and body parameter text on those routes.The REST API reference renders these routes from
swagger.json, so they showed only a title.Merge notes
This PR doesn't touch the exemption lists in #31473.
If #31473 merges first,
TestEndpointsDocumentednames each route on this PR to remove from those lists.Verification
The
swagger.jsondiff againstorigin/mainchanges onlydescriptionvalues (10 changed, proven with a JSON walk that fails on any other change).Doc-check self-check
Ran the
doc-checkskill in author self-check mode on the branch diff, one persona at a time: Fact Checker, Continuity Editor, Copy Editor, then Skeptic on the survivors.No blocking findings. One suggestion left as is (see below), so there is no follow-up commit.
Skeptic rejected 0 findings.
Left as a suggestion:
POST /api/v2/ai/providerssays providers of typebedrockdon't acceptapi_keys, and the code also rejects them for any provider with Bedrocksettings.Claims checked against the code
coderd/coderd.go:2138(aiProvidersHandler(api, apiKeyMiddleware))GET /api/v2/ai/providers,GET .../{idOrName}coderd/database/dbauthz/dbauthz.go:3094-3113,3166-3171,coderd/rbac/roles.go:421-432(no other built-in role listsResourceAIProvider)POST /api/v2/ai/providerscoderd/ai_providers.go:178,coderd/database/dbauthz/dbauthz.go:6440PATCH .../{idOrName}coderd/ai_providers.go:327,coderd/database/dbauthz/dbauthz.go:7863DELETE .../{idOrName}coderd/database/dbauthz/dbauthz.go:2205GET /api/v2/ai/providerscoderd/ai_providers.go:60-62,codersdk/aiproviders.go:264-270GET /api/v2/ai/providers,.../{idOrName}statuscoderd/ai_providers.go:100,144,codersdk/aiproviders.go:254-262POST /api/v2/ai/providerscodersdk/aiproviders.go:22-25,292-314,465-477,549-570POST /api/v2/ai/providersbedrocktype rejectsapi_keyscodersdk/aiproviders.go:327-332,coderd/ai_providers.go:196-203POST /api/v2/ai/providerscoderd/ai_providers.go:257PATCH .../{idOrName}coderd/ai_providers.go:337,codersdk/aiproviders.go:462PATCH .../{idOrName}api_keysis the full post-patch set, existing byid, new byapi_key, others removedcodersdk/aiproviders.go:371-394DELETE .../{idOrName}enableddisables without deletingcoderd/ai_providers.go:430,codersdk/aiproviders.go:377{idOrName}coderd/ai_providers.go:603-618coderd/ai_providers.go:573-580Writing rules applied
dbauthzandroles.go.Part of DOCS-1439.
Generated by Coder Agents on behalf of @nickvigilante.