Skip to content

docs: link the canonical contract spec in tango contracts/README.md #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
makegov-mark wants to merge 1 commit into from
Closed

docs: link the canonical contract spec in tango contracts/README.md #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/DEVELOPERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,7 +514,7 @@ The SDK is kept in sync with the Tango API and its own shape schemas via conform

### The contract

- **Source:** Generated by the [tango](https://github.com/makegov/tango) repo's `scripts/filter_shape_conformance.py` from the API runtime (FilterSets, ordering fields, shape specs). Since `schema_version: 2` it carries per-filter type metadata (`filter_params_detail`: value type, choices, filter class).
- **Source:** Generated by the [tango](https://github.com/makegov/tango) repo's `scripts/filter_shape_conformance.py` from the API runtime (FilterSets, ordering fields, shape specs). Since `schema_version: 2` it carries per-filter type metadata (`filter_params_detail`: value type, choices, filter class). The canonical spec — schema, value-type vocabulary, evolution rules, and the consumer pattern this SDK implements — lives in tango's [`contracts/README.md`](https://github.com/makegov/tango/blob/staging/contracts/README.md).
- **Vendored copy:** `contracts/filter_shape_contract.json` pins exactly which API surface this SDK version conforms to. Refresh it with `uv run python scripts/refresh_contract.py` (reads the sibling `../tango` checkout, falling back to the GitHub API via `gh`). CI emits a staleness notice when the vendored copy drifts from tango HEAD.

### Filter conformance
Expand Down
Loading