[SYNPY-1896] Add SearchIndex to operations/utility_operations.py - #1445
Merged
Conversation
Registers SearchIndex alongside VirtualTable/MaterializedView in the find_entity_id, onweb, and print_entity Union type hints and TYPE_CHECKING import, completing its rollout across the operations/ factory layer.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates synapseclient.operations.utility_operations to recognize the SearchIndex model anywhere the module already accepts other table-like entities (e.g., VirtualTable / MaterializedView), aligning utility APIs with existing wiring elsewhere in operations/.
Changes:
- Adds
SearchIndextoTYPE_CHECKINGimports fromsynapseclient.models. - Extends the
Union[...]type hints forfind_entity_id/onweb/print_entity(and async variants) to includeSearchIndex. - Updates the corresponding docstrings to document
SearchIndexas an accepted entity type.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
andrewelamb
approved these changes
Aug 17, 2026
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.
Summary
SearchIndexwas already wired intostore_operations.py,delete_operations.py, andfactory_operations.py, but missing fromutility_operations.py.VirtualTable/MaterializedViewin theTYPE_CHECKINGimport andUniontype hints forfind_entity_id,onweb, andprint_entity(sync + async), plus matching docstrings.Test plan
black/ruffclean on the changed fileJira: https://sagebionetworks.jira.com/browse/SYNPY-1896