Repository navigation
docs: describe the license and appearance API operations - #31543
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 describes the license, entitlements, appearance, premium funnel, and notification template method routes, and improves their parameter text. Part of DOCS-1439. Assisted-by: AI
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.
This adds a
@Descriptionto the 10 license, entitlements, appearance, premium funnel, and notification template method routes in the Enterprise tag that had none, and improves the text of their six body and path parameters.The REST API reference renders these routes from
swagger.json, so their pages showed only a title.Merge notes
This PR doesn't touch #31473's exemption lists.
If #31473 merges first,
TestEndpointsDocumentednames each route on this PR to remove from those lists.Verification
A JSON diff of
swagger.jsonagainstorigin/mainshows 10 operation descriptions and 6 parameter descriptions changed, and nothing else.The remaining thin parameter is
notification_template, a path ID that accepts only a UUID, soNotification template ID.is complete.Claims checked against the code
POST /api/v2/licensesenterprise/coderd/coderd.go:399-406(onlyapiKeyMiddleware, noRequireFeatureMW),enterprise/coderd/licenses.go:96POST /api/v2/licenses,POST .../trial,POST .../refresh-entitlementsenterprise/coderd/licenses.go:96,160,323,coderd/rbac/roles.go:422(Owner gets all permissions except the listed ones, licenses are not excluded), no other role grants license permissionsPOST /api/v2/licenses400for an invalid key or a key locked to another deploymententerprise/coderd/licenses.go:62-70,106-123POST /api/v2/licenses/refresh-entitlements400withRetry-Aftercoderd/entitlements/entitlements.go:91-101,enterprise/coderd/licenses.go:330-334POST /api/v2/licenses/trial409when the deployment already has a license; request goes to the license serverenterprise/coderd/licenses.go:171-195POST /api/v2/licenses/trialsourceandattribution_idare for telemetry and aren't forwardedcodersdk/licenses.go:43-48,enterprise/coderd/licenses.go:179-190GET /api/v2/licensesenterprise/coderd/licenses.go:401,coderd/rbac/roles.go:422DELETE /api/v2/licenses/{id}enterprise/coderd/licenses.go:437,460GET /api/v2/entitlementsenterprise/coderd/coderd.go:1431-1434,codersdk/deployment.go:540-548GET /api/v2/entitlementsenterprise/coderd/coderd.go:371-372(route registered with noapiKeyMiddleware)GET /api/v2/entitlementssite/src/api/api.tscalls/api/v2/entitlementsGET /api/v2/appearanceenterprise/coderd/coderd.go:696-707(RequireAPIKeyOrWorkspaceAgent)GET,PUT /api/v2/appearanceenterprise/coderd/coderd.go:1175-1190,coderd/appearance/appearance.go:21-31PUT /api/v2/appearanceenterprise/coderd/appearance.go:163,176,197-230,coderd/rbac/roles.go:422,495POST /api/v2/deployment/premium-funnel-events404without read on licensescoderd/premiumfunnel.go:33-36,59-76POST /api/v2/deployment/premium-funnel-eventssite/src/api/api.tsandsite/src/api/queries/premiumFunnel.ts(dashboard client)POST /api/v2/deployment/premium-funnel-eventsvariantispremium,small, orai_governancecodersdk/premiumfunnel.go:81-83PUT /api/v2/notifications/templates/{notification_template}/methodsmtp,webhook,inbox;304when unchangedcoderd/database/models.go:2874-2876,enterprise/coderd/notifications.go:46-72coderd/database/dbauthz/dbauthz.go:8387-8392,coderd/rbac/roles.go:422doc-check self-check
Author self-check mode, run on the annotation text in the diff, with nothing posted to GitHub.
Personas that ran: Fact Checker, Consistency, Language, and Skeptic (verifier).
Personas skipped: Cartographer, Newcomer, Reader Advocate, and Architect, because no hand-written docs page or navigation changed, only annotation text and its generated output.
No blocking findings remain.
make lint/emdashpassed, and the generateddocs/reference/api/enterprise.mdwent through the markdownlint step ofmake gen.Writing rules applied
POST /api/v2/licenses, because adding a license can't require one, and none on routes that have noRequireFeatureMW.roles.go.GET /api/v2/entitlementssays it doesn't require a session token, andGET /api/v2/appearancenames the workspace agent token alternative.Part of DOCS-1439.
Generated by Coder Agents on behalf of @nickvigilante.