docs: correct the searchControls constraint and exposed claims - #22
Merged
Conversation
Two contradictions introduced by #21, both found in review. The prose claimed constraint appears only on the numeric parameters while the table listed it for attributesToRetrieve and responseFields as well. That conflated "the key exists" with "it carries a {min, max} shape". Re-derived from 21 indices across the 12 live agents: four parameters carry a constraint key — hitsPerPage, page, attributesToRetrieve, responseFields — and only hitsPerPage was ever observed with one populated. merge was null in every record, so neither its purpose nor the constraint shape on those two parameters is known. `exposed: true` was described as varying the value "within its constraint", but distinct and facets have no constraint key at all. Reworded so the constraint is only mentioned where one is present. The unconfirmed list now covers merge and any constraint beyond hitsPerPage, rather than implying the rest is settled. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.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.
Follow-up to #21, fixing two contradictions that PR introduced.
1.
constraintis not numeric-onlyThe prose said
constraintappears only on the numeric parameters, while the table two lines below listedconstraintforattributesToRetrieveandresponseFields. A flat contradiction — I had conflated the key exists with it carries a{min, max}shape.Re-derived from 21 indices across the 12 live agents rather than from memory:
constraintkeymergekeyhitsPerPageconstraint={min, max}pageattributesToRetrieveresponseFieldsdistinct,facetsSo four parameters carry a
constraintkey and onlyhitsPerPagewas ever seen with one populated.mergewasnullin every record, which means both its purpose and whetherconstrainton those two takes the{min, max}form are unknown. The README now says exactly that instead of over-claiming.2.
exposeddescribed a constraint that may not exist"vary the value within its constraint" is wrong for
distinctandfacets, which have noconstraintkey. Reworded:Note on provenance
The
distinctandfacetsshapes in this table were observed on a test agent that has since been deleted, so they are no longer reproducible from the account. The observation was real and recorded at the time, but anyone re-deriving this table from live data today will find those four parametersnullthroughout. That is part of why the section states its provenance rather than presenting itself as a schema.Docs only; no code change.
🤖 Generated with Claude Code