Search fix debug info #40187
Open
Search fix debug info #40187
Conversation
This file contains 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
|
API change check API changes are not detected in this pull request. |
There was a problem hiding this comment.
Pull Request Overview
This PR fixes the deserialization issue for document_debug_info in search results and updates the code generation metadata to use AutoRest version 6.30.0.
- Fixed the deserialization bug by changing document_debug_info from a list to a single object.
- Updated the AutoRest generator version across multiple generated files.
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| sdk/search/azure-search-documents/CHANGELOG.md | Added changelog entry for the document_debug_info deserialization bug fix |
| sdk/search/azure-search-documents/azure/search/documents/_generated/_search_index_client.py | Updated AutoRest generator version |
| sdk/search/azure-search-documents/azure/search/documents/_generated/models/_search_index_client_enums.py | Updated AutoRest generator version |
| sdk/search/azure-search-documents/azure/search/documents/_generated/_configuration.py | Updated AutoRest generator version |
| sdk/search/azure-search-documents/azure/search/documents/_generated/models/_models_py3.py | Changed document_debug_info type and its initialization to reflect a single debug info object |
| sdk/search/azure-search-documents/azure/search/documents/_generated/aio/_configuration.py | Updated AutoRest generator version |
| sdk/search/azure-search-documents/azure/search/documents/_generated/aio/_search_index_client.py | Updated AutoRest generator version |
| sdk/search/azure-search-documents/azure/search/documents/_generated/models/init.py | Updated AutoRest generator version |
| sdk/search/azure-search-documents/azure/search/documents/_generated/aio/init.py | Updated AutoRest generator version |
| sdk/search/azure-search-documents/azure/search/documents/_generated/operations/init.py | Updated AutoRest generator version |
| sdk/search/azure-search-documents/azure/search/documents/_generated/operations/_documents_operations.py | Updated AutoRest generator version |
| sdk/search/azure-search-documents/azure/search/documents/_generated/aio/operations/_documents_operations.py | Updated AutoRest generator version |
| sdk/search/azure-search-documents/azure/search/documents/_generated/init.py | Updated AutoRest generator version |
| sdk/search/azure-search-documents/azure/search/documents/_generated/aio/operations/init.py | Updated AutoRest generator version |
Comments suppressed due to low confidence (1)
sdk/search/azure-search-documents/azure/search/documents/_generated/models/_models_py3.py:1842
- The updated initialization for document_debug_info now supports a single debug info object instead of a list. Verify that any client consuming this model is adjusted to handle a single object.
self.document_debug_info: Optional["_models.DocumentDebugInfo"] = None
| @@ -1807,7 +1807,7 @@ class SearchResult(_serialization.Model): | |||
| :vartype captions: list[~azure.search.documents.models.QueryCaptionResult] | |||
| :ivar document_debug_info: Contains debugging information that can be used to further explore | |||
| your search results. | |||
| :vartype document_debug_info: list[~azure.search.documents.models.DocumentDebugInfo] | |||
| :vartype document_debug_info: ~azure.search.documents.models.DocumentDebugInfo | |||
There was a problem hiding this comment.
Changing the document_debug_info type from a list to a single object might break expectations if multiple debug info entries are expected. Please confirm that the API response is updated accordingly and update any dependent code.
Suggested change
| :vartype document_debug_info: ~azure.search.documents.models.DocumentDebugInfo | |
| :vartype document_debug_info: list[~azure.search.documents.models.DocumentDebugInfo] |
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
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.
No description provided.