[ENG-3760] docs: add v2.12.0 ConnectProvider module prop and headless updates#526
Merged
[ENG-3760] docs: add v2.12.0 ConnectProvider module prop and headless updates#526
Conversation
Document the new `module` prop for ConnectProvider, `getReadObjects` for useManifest, `ensureObject`/`removeObject` for useLocalConfig, and provider auto-populate behavior for useCreateInstallation. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
|
@dionlow please re-request review once this has been updated with the new names. |
Replace ensureObject with readObject().setEnableRead()/setDisableRead() to match the write pattern naming. Remove mention of client-side required fields pre-filling (backend handles defaults now). Add deleteFieldMapping to ReadObjectHandlers docs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
dionlow
commented
Mar 18, 2026
dionlow
commented
Mar 18, 2026
v2.12.0 was unpublished; all features shipped in v2.12.1. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
Author
|
Ready for review. Broken links test fixed here: #530 |
Tighten module prop description, reduce redundancy in getReadObjects section, restructure setEnableRead/setDisableRead/removeObject as a bullet list with a Note callout for auto-enable behavior, and clarify code example comments. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
laurenzlong
approved these changes
Mar 19, 2026
Co-authored-by: Lauren Long <laurenzlong@users.noreply.github.com>
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
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.
Summary
moduleprop forConnectProvider(module-specific metadata collection, auto-showing metadata form for existing connections)getReadObjectstouseManifestdocumentation (bulk retrieval of all read objects from manifest)ensureObjectandremoveObjecttouseLocalConfigdocumentation (add/remove objects from draft config with manifest defaults)useCreateInstallationauto-populatingconfig.providerfrom the integration objectTest plan