Search Configuration API #1666
Open
Search Configuration API #1666
+99
−0
Conversation
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
☂️ Python Coverage
Overall Coverage
New Files
Modified Files
|
doctrino
reviewed
Jun 23, 2025
Comment on lines
21
to
39
| @overload | ||
| def __call__(self) -> Iterator[SearchConfig]: ... | ||
|
|
||
| @overload | ||
| def __call__(self, chunk_size: int) -> Iterator[SearchConfigList]: ... | ||
|
|
||
| def __call__(self, chunk_size: int | None = None) -> Iterator[SearchConfig] | Iterator[SearchConfigList]: | ||
| """Iterate over configurations. | ||
| Args: | ||
| chunk_size: The number of configurations to return in each chunk. None will return all configurations. | ||
|
|
||
| Yields: | ||
| SearchConfig or SearchConfigList | ||
|
|
||
| """ | ||
| return iter(self.list()) | ||
|
|
||
| def __iter__(self) -> Iterator[SearchConfig]: | ||
| return self.__call__() |
There was a problem hiding this comment.
This endpoint does not support pagination, so lets skip this
Suggested change
| @overload | |
| def __call__(self) -> Iterator[SearchConfig]: ... | |
| @overload | |
| def __call__(self, chunk_size: int) -> Iterator[SearchConfigList]: ... | |
| def __call__(self, chunk_size: int | None = None) -> Iterator[SearchConfig] | Iterator[SearchConfigList]: | |
| """Iterate over configurations. | |
| Args: | |
| chunk_size: The number of configurations to return in each chunk. None will return all configurations. | |
| Yields: | |
| SearchConfig or SearchConfigList | |
| """ | |
| return iter(self.list()) | |
| def __iter__(self) -> Iterator[SearchConfig]: | |
| return self.__call__() |
| def __iter__(self) -> Iterator[SearchConfig]: | ||
| return self.__call__() | ||
|
|
||
| def update(self, configuration_update: SearchConfigWrite) -> SearchConfig: |
There was a problem hiding this comment.
Suggested change
| def update(self, configuration_update: SearchConfigWrite) -> SearchConfig: | |
| def upsert(self, configuration_update: SearchConfigWrite) -> SearchConfig: |
|
|
||
|
|
||
| @pytest.fixture(scope="session") | ||
| def existing_search_config(toolkit_client: ToolkitClient) -> dict: |
There was a problem hiding this comment.
Why not return a SearchConfig here?
Suggested change
| def existing_search_config(toolkit_client: ToolkitClient) -> dict: | |
| def existing_search_config(toolkit_client: ToolkitClient) -> SearchConfig: |
There was a problem hiding this comment.
I also wanted count of already present configs thus was returning in dict. Could use tuple instead. with first element as count and second as SearchConfig. id can be fetched using SearchConfig.id
There was a problem hiding this comment.
since not explicitly testing list() method so will just return SearchConfig
Comment on lines
45
to
49
| def test_list_search_configurations(self, toolkit_client: ToolkitClient, existing_search_config: dict) -> None: | ||
| """Test that we can list search configurations.""" | ||
| search_configs = toolkit_client.search_configurations.list() | ||
| assert isinstance(search_configs, SearchConfigList) | ||
| assert len(search_configs) == existing_search_config["total_configs"] |
There was a problem hiding this comment.
I think this is already tested in the fixture
doctrino
previously approved these changes
Jun 24, 2025
doctrino
added
the
waiting-for-risk-review
Aashutosh-cognite
dismissed
doctrino’s stale review
The base branch was changed.
doctrino
approved these changes
Jun 27, 2025
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.
Description
Stacked on #1651
This PR introduces to search configurations API client to utilise list and update APIs for configurations. This will be used by Configurations resources to load search config resources and validate it.
Changelog