[ENG-3818] docs: document read field filters in manifest reference - #725
Open
eberle1080 wants to merge 2 commits into
Open
eberle1080 wants to merge 2 commits into
eberle1080 wants to merge 2 commits into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
The manifest schema reference had no mention of read filters, so anyone searching that page for how to filter records found nothing and no pointer. `fieldFilters` is not a manifest field — it exists only in the installation config schema — so document it as such rather than as amp.yaml syntax. manifest-reference: - Pointer under the read object table drawing the which-fields vs which-records distinction. - Bullet in the backfill considerations noting the installation config's backfill object accepts fieldFilters, which amp.yaml does not. - New "Field filters" section under Details: JSON example, field table, AND semantics, provider support, and object-level vs backfill-scoped precedence. read-actions: - New "Filter field names" section documenting that fieldName must be the provider's API name and that field mappings are not resolved for read filters, unlike search actions. Also notes the filter field need not be in selectedFields. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
eberle1080
force-pushed
the
docs/read-field-filters
branch
from
September 14, 2026 19:18
be58bbc to
df40844
Compare
eberle1080
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.
Description
The manifest schema reference had no mention of read filters, while read actions documents them. Anyone searching the manifest page for how to filter records found nothing and no pointer to where the feature lives.
fieldFiltersis not a manifest field — it exists only in the installation config schema (IntegrationObjectand the manifest'sBackfillhave no filter key), so this documents it as an installation-config field rather than inventingamp.yamlsyntax.search-actions.mdxalready sets the same kind of manifest-vs-installation-config boundary.manifest-reference.mdxbackfillobject accepts one extra key,fieldFilters, whichamp.yamldoes not.fieldName/operator/value, AND semantics, provider support, and object-level vs. backfill-scoped precedence.read-actions.mdxfieldNamemust be the provider's API name and is case-sensitive, and field mappings are not resolved for read filters — unlike search actions, which do accept mapped names. Includes a correct/incorrect example pair reusing themobilephone→phonemapping from the manifest page so the two read consistently.selectedFields.The mapping behavior is the one genuinely new fact here, sourced from the code: reads pass
fieldNamethrough verbatim (server/shared/workflow/read/state.go:677), while search resolves it againstSelectedFieldMappings(server/api/routes/search/search.go:207-211). It wasn't documented on either page.Screenshot
pnpm run test:linkspasses.Known gaps not addressed here
Two caveats about filtered reads remain undocumented and are larger than a cross-reference:
lists, marketing objects, communication objects, meeting-links, activity events) — those route away beforeBuildBuilderFiltersis applied inconnectors/providers/hubspot/read.go.fullHistorybackfill or triggered read goes throughListReaderrather thanSearchReader, so it bypasses the 10K-record windowing workaround.🤖 Generated with Claude Code