feat(indexes): add vector_precision field to index operations - #145
hotdata-automation[bot] wants to merge 1 commit into
Conversation
|
|
||
| ### Changed | ||
|
|
||
| - feat(indexes): add vector_precision field to index operations |
There was a problem hiding this comment.
Document the breaking API changes in this Unreleased section.
scripts/update_changelog.py:15-19 copies the Unreleased body verbatim into the released section. So this single line becomes the whole release note.
The diff breaks three parts of the public API:
key_determinesis gone fromAddManagedTableDecl,AddManagedTableRequestandDatabaseDefaultTableDecl, replaced byconstant_per_key.TableInfo::newtakes a new requiredconstant_per_key: Vec<String>argument.JobTypegains theTableConstantsUpdatevariant, which breaks an exhaustivematchdownstream.
Failure scenario: a caller on 0.18.0 sets key_determines on a table declaration. That field was announced as a feature in CHANGELOG.md:73. After upgrading, the caller fails to compile with no field named key_determines. The release notes mention only vector_precision, so the caller has no migration path.
Add a ### Removed or **Breaking:** entry in the style of CHANGELOG.md:37 and CHANGELOG.md:85. Name the old and the new field. The semver policy at CHANGELOG.md:6 also makes this a minor bump, not the patch bump that RELEASING.md:66 describes for regeneration.
Also list the other new surface: the two constant-per-key endpoints, vector_precision on CreateIndexRequest, IndexInfoResponse and IndexEntryResponse, and TableInfo.constant_per_key.
There was a problem hiding this comment.
Review
Blocking Issues
CHANGELOG.md:12records only thevector_precisionaddition. The diff also removeskey_determinesfrom three request models, adds a required argument toTableInfo::new, and adds aJobTypevariant. All three break callers of 0.18.0.
Action Required
- Rewrite the Unreleased body to name the breaking changes, following the
**Breaking:**style used atCHANGELOG.md:37andCHANGELOG.md:85. - List the new surface too: the two
constant-per-keyendpoints,vector_precisionon the index request and responses, andTableInfo.constant_per_key.
Notes
- No hand-written code in
src/,tests/orexamples/referenceskey_determinesorTableInfo::new, so the crate itself still builds. Integration Tests / integrationwas still running when this review started.TableInfo.constant_per_keyis required with no serde default, so that job fails if the API under test omits the field.
Auto-generated from the updated HotData OpenAPI spec.
Source: https://github.com/hotdata-dev/www/pull/428