Repository navigation
docs: describe the IdP sync API operations and parameters - #31523
Closed
nickvigilante wants to merge 2 commits into
Closed
nickvigilante wants to merge 2 commits into
nickvigilante wants to merge 2 commits into
Conversation
The REST API reference renders these routes from swagger.json, and they had no description. Part of DOCS-1439. Assisted-by: AI
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 a
@Descriptionto the 16 IdP sync routes taggedEnterprise, and improves the thin parameter text on them.The REST API reference renders these routes from
swagger.json, and they had no description.doc-check
Fact Checker, Continuity Editor, Copy Editor, and Skeptic ran on the branch diff (author self-check).
Findings fixed in the follow-up commit:
assign_defaultandorganization_assign_defaultfor one setting, so the full-settings and mapping text now say "the default-organization setting" and "the other settings".field" and "organization sync claimfield").The Skeptic rejected 1 finding: sentence length over 25 words in the pointer sentences (the style guide calls the budget a target, not a ceiling).
Not changed: group, role, and organization sync only take effect with the matching entitlement at login time (
enterprise/coderd/enidpsync/groups.go:13,organizations.go:14,role.go:21), but these routes have no license check, so the text makes no license claim.Deterministic checks after the follow-up commit:
check_routes.py, both swagger tests, andmake lint/emdashpass.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/mainchanges onlydescriptionvalues (34 leaves, all underpaths, all on the 16 routes).The two remaining thin parameters are the
organizationparameters on the deployment-levelavailable-fieldsandfield-valuesroutes, which #30124 removes, so this PR leaves them alone.Claims checked against the code
/api/v2/organizations/{organization}/settings/idpsync/*organizationaccepts an ID, a name, ordefaultenterprise/coderd/coderd.go:497(and the otherExtractOrganizationParamgroups),coderd/httpmw/organizationparam.go:72GETroutesenterprise/coderd/idpsync.go:36,:307;coderd/rbac/roles.go:549(User Admin),:662(Organization User Admin); Owner and Organization Admin throughallPermsExceptatroles.go:414,:601PATCHroutesidpsync.go:79,:166,:242,:350,:417,:487/api/v2/settings/idpsync/organization*idpsync.go:545,:588,:655,:724;roles.go:549GET .../available-fields,.../field-values(both scopes)coderd/database/dbauthz/dbauthz.go:7555,:7566;idpsync.go:803,:858GET .../available-fields,.../field-valuescoderd/database/queries/user_links.sql:64,:84GET .../field-values400whenclaimFieldis emptyidpsync.go:862PATCH .../groupslegacy_group_name_mappingidpsync.go:89,:114PATCH .../groups/configfield,regex_filter, andauto_create_missing_groups, and keepsmappingidpsync.go:191PATCH .../roles,.../roles/config/roles, and/roles/configsetsfieldand keepsmappingidpsync.go:371,:439PATCH .../organization,.../organization/configfieldandassign_defaultand keepsmappingidpsync.go:610,:678PATCH .../mappingroutesaddthenremove, so an entry in both ends up removed, and keep the other settingsidpsync.go:262,:507,:744,:904,:911enterprise/coderd/coderd.go:481to:512has noRequireFeatureMWWriting rules applied
@Descriptionline.api.Authorizecall andcoderd/rbac/roles.go.<,>,{, or}outside them.configandmappingroute says what it keeps, so a reader can tell it from the full-settingsPATCH.Part of DOCS-1439.
Generated by Coder Agents on behalf of @nickvigilante.