Package Name
azure-search-documents
Package Version
12.1.0b1
Operating System
macOS
Python Version
3.14
Describe the bug
This is a public API regression because the practical round-trip helpers are now only available through underscored methods, forcing external callers to choose between using internal APIs or re-implementing the behavior themselves.
In azure-search-documents==12.1.0b1, SearchIndex no longer exposes clear public serialize() / deserialize() methods for external callers. The functionality still appears to exist through underscored methods such as _serialize and _deserialize, but external developers should not be expected to rely on underscored methods as public SDK contract.
To Reproduce
- Install
azure-search-documents==12.1.0b1
- Run:
from azure.search.documents.indexes.models import SearchIndex
index = SearchIndex(name="x", fields=[])
for name in ["serialize", "deserialize", "_serialize", "_deserialize", "as_dict"]:
print(name, hasattr(index, name), getattr(index, name, None))
Expected behavior
There should be a clear, public round-trip API for SearchIndex models.
Ideally one of these should be true:
serialize() and deserialize() are publicly exposed and supported
- the documentation explicitly states that some other non-underscored API is the supported replacement
Actual behavior
The obvious public methods are not available, while the internal underscored methods remain present. That leaves external callers in an awkward position: either depend on internal methods that are not part of the public contract, or re-implement serialization/deserialization behavior themselves.
Screenshots
N/A
Package Name
azure-search-documents
Package Version
12.1.0b1
Operating System
macOS
Python Version
3.14
Describe the bug
This is a public API regression because the practical round-trip helpers are now only available through underscored methods, forcing external callers to choose between using internal APIs or re-implementing the behavior themselves.
In
azure-search-documents==12.1.0b1,SearchIndexno longer exposes clear publicserialize()/deserialize()methods for external callers. The functionality still appears to exist through underscored methods such as_serializeand_deserialize, but external developers should not be expected to rely on underscored methods as public SDK contract.To Reproduce
azure-search-documents==12.1.0b1Expected behavior
There should be a clear, public round-trip API for
SearchIndexmodels.Ideally one of these should be true:
serialize()anddeserialize()are publicly exposed and supportedActual behavior
The obvious public methods are not available, while the internal underscored methods remain present. That leaves external callers in an awkward position: either depend on internal methods that are not part of the public contract, or re-implement serialization/deserialization behavior themselves.
Screenshots
N/A