[LA-36925] Document customField clear + occupationRole#54
Merged
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
Author
|
Renamed per review. The param and response field is now I think It also stays clearly distinct from the system permission Docs updated to use |
tejanium
changed the title
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Jira
https://learnamp.atlassian.net/browse/LA-36925
What
Documents two verified behaviours on the user-update API (
PUT /v1/users/:idand theby_integration_external_idvariant) insource/includes/_users.md:"value": nullor"value": ""to clear a field; omitting a field leaves it unchanged; clearing a presence-validated field returns400 Bad Request(value retained); an unknown fieldnamereturns404 Not Found.occupationRole— new optional string attribute. Assigns an occupation role as the user's primary role and applies its target skills. Unknown role name returns422 Unprocessable Entity. Returned on the user object and readable back viaGET /v1/users/:id.Why
Integrators need accurate docs for these shipped behaviours (customField clearing and occupation-role assignment).
Anything Else
Docs-only change. No build run (Slate/Middleman site; build requires the full gem bundle and is not quick).
Note
Low Risk
Documentation-only change to Slate API reference; no runtime or API behavior changes in this PR.
Overview
Updates the Users API docs in
_users.mdfor user update flows (PUT /v1/users/{id}and by integration external ID).Documents optional
occupationRole: skills-matrix role name on update, returned on user JSON in show/create/update examples, with422when the name does not exist in the company.Adds a Clearing custom field values section: clear via
nullor"", omission leaves values unchanged, presence-validated fields cannot be cleared (400), unknown field names404, andcustomFieldsignored when the feature is disabled. Links thecustomFieldsparameter to that section and adds matching error response examples.Notes that the integration-external-id update route follows the same
customFields/occupationRolebehavior.Reviewed by Cursor Bugbot for commit 8941a95. Bugbot is set up for automated code reviews on this repo. Configure here.