Repository navigation
fix(collection): return the partial update schema from Collection.update - #378
Merged
Merged
Conversation
tharropoulos
reviewed
Oct 9, 2026
tharropoulos
left a comment
Collaborator
There was a problem hiding this comment.
Thank you for the contribution! just a small nitpick about testing scope.
| CollectionUpdateSchema, | ||
| } from "../src/Typesense/Collection"; | ||
|
|
||
| describe("collection update", () => { |
Collaborator
There was a problem hiding this comment.
instead of a type test here, could we add a type test and runtime validation under the existing Collection.spec.ts tests?
Contributor
Author
|
Moved the test into the existing |
tharropoulos
approved these changes
Oct 10, 2026
Collaborator
|
Thank you for your contribution! |
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.
Collection.update()insrc/Typesense/Collection.tsnow returnsPromise<CollectionUpdateSchema>, which matches the partial PATCH response.The previous
CollectionSchemareturn type promised full collection properties that the response does not contain.Callers that need
nameornum_documentscan useretrieve().CollectionUpdateSchemacovers field-drop entries and metadata-only responses and matches the OpenAPI response definition.Runtime request behavior is unchanged.
The regression tests in
test/collection-update.type.test.tsrequire the partial return type and reject the full collection type.Both fail against the original source and pass with this change.
Fixes #150.