Repository navigation
docs(connectors): a connector's label can be renamed after creation - #16321
Open
paulOsinski wants to merge 1 commit into
Open
paulOsinski wants to merge 1 commit into
paulOsinski wants to merge 1 commit into
Conversation
The Pro connectors API now accepts a label change on an existing configuration and keeps every mapped Record linked to its Engagement by ID, so the docs stop implying the label is fixed and spell out that renaming it neither moves nor duplicates the Engagements and Tests the connector already created. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This branch has not been deployed
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.
Description
Documentation update for a Pro connectors change: a connector configuration's Label can now be renamed after creation.
The connectors API used to refuse a label change on an existing configuration, because the Engagement a mapped Record fed was resolved by its generated name (
Global Connectors - <label> - <vendor product>) on every discover and assign pass. A rename would have minted a fresh Engagement under the new name and stranded the old one. The Record is now linked to its Engagement by ID, so the label is purely cosmetic.Two pages change:
connectors/upstream/add_edit.md: the Label step now says the label can be renamed later from Edit Configuration without affecting the connector's existing Records, Engagements or Tests, and that each connector type can use a label only once.connectors/upstream/manage_records.md: the Engagement bullet now gives the real Engagement name shape and states that renaming the connector's label does not create a new Engagement and syncs keep landing in the existing one.Test results
Docs-only change.
Documentation
This PR is the documentation.
🤖 Generated with Claude Code