docs(entities): document the pipe-OR syntax socioeconomic accepts - #59
Merged
Conversation
The server has always ORed pipe-separated values (`socioeconomic="8A|WOSB"`), but neither the docstring nor the API reference said so, and no test pinned the verbatim passthrough. A user analyzing awards to Black-owned businesses hit this gap while trying to filter entities by socioeconomic designation. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
… examples
Live testing showed the example codes were the wrong vocabulary: the filter matches SAM business-type codes, and set-aside-style values like "8A" or "WOSB" silently match zero rows.
Examples now use real codes ("OY" Black American Owned, "A2" Woman Owned), the docs name the vocabulary and point at GET /api/business_types/, and the passthrough tests pin the corrected value.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Merged
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.
What
Documents the pipe-OR syntax the
socioeconomicfilter onlist_entitieshas always supported, and pins the behavior with tests.list_entitiesdocstring anddocs/API_REFERENCE.mdnow show the multi-value form:socioeconomic="8A|WOSB"matches entities holding any of the listed designations.TestEntityFiltersasserts the pipe-separated value is forwarded verbatim in the query string, and that the param is omitted when unset.## [Unreleased]→### Documentation.Why
A user analyzing federal awards to Black-owned businesses couldn't tell from the SDK docs that OR-combining socioeconomic codes was supported. The server has always implemented it; the SDK just forwards the string, but nothing said so and no test protected the passthrough.
Testing
uv run pytest tests/ -m "not integration"— 346 passed, 30 skipped.uv run ruff check/ruff format --checkon changed files — clean.uv run mypy tango/— no issues.scripts/check_filter_shape_conformance.pyandscripts/check_shape_coverage.py— exit 0.Risks
None — docs and tests only; no behavior change.
🤖 Generated with Claude Code