Open
Conversation
API Change CheckAPIView identified API level changes in this PR and created the following API reviews |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the azure-search-documents package to support listing indexes with selected properties (via $select), introducing a dedicated response model and plumbing a new/alternate request path through the sync + async index operations. It also includes some API metadata and docstring updates.
Changes:
- Add
SearchIndexResponsemodel and expose it fromazure.search.documents.indexes.models. - Add a
selectparameter toSearchIndexClient.list_indexes()(sync + async) that switches to a$select-enabled listing path and response type. - Update APIView/metadata files and refresh API version docstrings across multiple clients/configurations.
Reviewed changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/search/azure-search-documents/azure/search/documents/models/_patch.py | Minor formatting change in model patch module. |
| sdk/search/azure-search-documents/azure/search/documents/knowledgebases/aio/_configuration.py | Updates knowledgebases async configuration docstring for api_version. |
| sdk/search/azure-search-documents/azure/search/documents/knowledgebases/aio/_client.py | Updates knowledgebases async client docstring for api_version. |
| sdk/search/azure-search-documents/azure/search/documents/knowledgebases/_configuration.py | Updates knowledgebases sync configuration docstring for api_version. |
| sdk/search/azure-search-documents/azure/search/documents/knowledgebases/_client.py | Updates knowledgebases sync client docstring for api_version. |
| sdk/search/azure-search-documents/azure/search/documents/indexes/models/_models.py | Adds the new SearchIndexResponse model used for selected-properties index listings. |
| sdk/search/azure-search-documents/azure/search/documents/indexes/models/init.py | Exports SearchIndexResponse from the models package. |
| sdk/search/azure-search-documents/azure/search/documents/indexes/aio/_operations/_patch.py | Adds async list_indexes(select=...) wrapper and adjusts list_index_names implementation. |
| sdk/search/azure-search-documents/azure/search/documents/indexes/aio/_operations/_operations.py | Adds async plumbing for _list_indexes and list_indexes_with_selected_properties returning SearchIndexResponse. |
| sdk/search/azure-search-documents/azure/search/documents/indexes/aio/_configuration.py | Updates indexes async configuration docstring for api_version. |
| sdk/search/azure-search-documents/azure/search/documents/indexes/aio/_client.py | Updates indexes async client docstring for api_version. |
| sdk/search/azure-search-documents/azure/search/documents/indexes/_operations/_patch.py | Adds sync list_indexes(select=...) wrapper and adjusts list_index_names implementation. |
| sdk/search/azure-search-documents/azure/search/documents/indexes/_operations/_operations.py | Splits list-index request builders and adds list_indexes_with_selected_properties returning SearchIndexResponse. |
| sdk/search/azure-search-documents/azure/search/documents/indexes/_configuration.py | Updates indexes sync configuration docstring for api_version. |
| sdk/search/azure-search-documents/azure/search/documents/indexes/_client.py | Updates indexes sync client docstring for api_version. |
| sdk/search/azure-search-documents/azure/search/documents/aio/_configuration.py | Updates async search client configuration docstring for api_version. |
| sdk/search/azure-search-documents/azure/search/documents/aio/_client.py | Updates async search client docstring for api_version. |
| sdk/search/azure-search-documents/azure/search/documents/_configuration.py | Updates sync search client configuration docstring for api_version. |
| sdk/search/azure-search-documents/azure/search/documents/_client.py | Updates sync search client docstring for api_version. |
| sdk/search/azure-search-documents/apiview-properties.json | Updates APIView mappings for the new symbol/method. |
| sdk/search/azure-search-documents/_metadata.json | Adds apiVersions metadata alongside the existing apiVersion. |
sdk/search/azure-search-documents/azure/search/documents/indexes/models/_models.py
Show resolved
Hide resolved
sdk/search/azure-search-documents/azure/search/documents/indexes/_operations/_patch.py
Outdated
Show resolved
Hide resolved
sdk/search/azure-search-documents/azure/search/documents/indexes/_operations/_patch.py
Outdated
Show resolved
Hide resolved
sdk/search/azure-search-documents/azure/search/documents/_configuration.py
Show resolved
Hide resolved
sdk/search/azure-search-documents/azure/search/documents/indexes/_configuration.py
Show resolved
Hide resolved
sdk/search/azure-search-documents/azure/search/documents/knowledgebases/_configuration.py
Show resolved
Hide resolved
hizixin
approved these changes
Feb 13, 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.
Description
Please add an informative description that covers that changes made by the pull request and link all relevant issues.
If an SDK is being regenerated based on a new API spec, a link to the pull request containing these API spec changes should be included above.
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines