Repository navigation
docs: describe the Git API operations and parameters - #31546
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. 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 PR adds descriptions for the 5
Insightsroutes and improves 13 of their parameters.The REST API reference renders these routes from
swagger.json, and they had no description.Merge notes
This PR doesn't touch the exemption lists from #31473.
If #31473 merges first,
TestEndpointsDocumentednames each route on this PR to remove from those lists.Verification
A JSON diff of
coderd/apidoc/swagger.jsonagainstorigin/mainchanges onlydescriptionvalues on the routes in this PR.Claims checked against the code
tz_offsethours from UTC (default 0)timezoneandtz_offsetcan't be combined; default UTCstart_timemust be 00:00:00 and neither time can be later than the end of the current hour;end_timemust be 00:00:00 unless it falls on the current day, when it must be on the hour;end_timeisn't beforestart_timeintervalisdayorweek;weekneeds the last period to span at least 6 days; omitted means nointerval_reportstemplate_idsis a comma-separated UUID list with no default restrictionConnectionLatency)doc-check self-check
Ran in author self-check mode on the branch diff, annotation text only: Fact Checker, Continuity Editor, Copy Editor, and then the Skeptic.
The other personas didn't run because no Markdown page was written by hand, and
docs/reference/api/is generated.Fact Checker: No findings.
Every claim about links, refresh, revocation, and the device flow was checked against
coderd/externalauth.goandcoderd/httpmw/externalauthparam.go.Continuity Editor: No findings.
The text uses "external authentication" throughout, matching the product term, and the four
externalauthparameters share one wording.Copy Editor: No findings.
Skeptic: kept 0 and rejected 2.
One ambiguity finding about "which creates the link or replaces the existing one", rejected because the antecedent is the exchange and no rule applies.
One finding that "poll no faster than the
interval" lacks code support, rejected becauseintervalis the provider's value returned inExternalAuthDevice(codersdk/externalauth.go:123-129) and the sentence tells the reader to use it.No blocking findings remain.
Writing rules applied
coderd/rbac/roles.goand the handler ordbauthzcheck.user,limit,offset) use the shared wording only where the handler matches it.CI flakes unrelated to this change
test-go-pg (windows-2022)failed inagent/x/agentacpTestAPISessionRecoveryWriteDeadline/message, a package this PR doesn't touch: https://github.com/coder/coder/actions/runs/40935546267/job/123665191347Part of DOCS-1439.
Generated by Coder Agents on behalf of @nickvigilante.