fix: allow metadata-only collection updates - #228
Open
alnr wants to merge 1 commit into
Open
Conversation
CollectionUpdateSchema.Fields was generated as `json:"fields"`, so an update changing only `metadata` still serialized `"fields":null`. Typesense rejects that with a 400, as it does `"fields":[]`, which left no value of Fields that could express a metadata-only update. The server applies and persists the metadata change before it validates `fields`, so callers got back an error describing a write that had actually happened. The upstream spec no longer marks `fields` as required (typesense/typesense-api-spec#107), making the property optional. Generating it with x-go-type-skip-optional-pointer keeps it as []Field rather than *[]Field, so it gains `omitempty` without breaking callers that construct a CollectionUpdateSchema. Only the CollectionUpdateSchema portion of the vendored spec is updated here. Re-vendoring wholesale would revert the local `hits` patch from typesense#216 and rename EnableOverrides/OverrideTags, which belongs in its own change.
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.
Change Summary
CollectionUpdateSchema.Fields was generated as
json:"fields", so an update changing onlymetadatastill serialized"fields":null. Typesense rejects that with a 400, as it does"fields":[], which left no value of Fields that could express a metadata-only update. The server applies and persists the metadata change before it validatesfields, so callers got back an error describing a write that had actually happened.The upstream spec no longer marks
fieldsas required (typesense/typesense-api-spec#107), making the property optional. Generating it with x-go-type-skip-optional-pointer keeps it as []Field rather than *[]Field, so it gainsomitemptywithout breaking callers that construct a CollectionUpdateSchema.Only the CollectionUpdateSchema portion of the vendored spec is updated here. Re-vendoring wholesale would revert the local
hitspatch from #216 and rename EnableOverrides/OverrideTags, which belongs in its own change.PR Checklist