fix(specs): document abTest field on listIndices response (generated)

algolia/api-clients-automation#6443

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Eric Zaharia <94015633+eric-zaharia@users.noreply.github.com>

Author: algolia-bot

algoliasearch/search/models/__init__.py

@@ -78,6 +78,9 @@
 from .facet_stats import FacetStats
 from .facets import Facets
 from .fetched_index import FetchedIndex
+from .fetched_index_ab_test import FetchedIndexAbTest
+from .fetched_index_ab_test_target import FetchedIndexAbTestTarget
+from .fetched_index_ab_test_variant import FetchedIndexAbTestVariant
 from .get_api_key_response import GetApiKeyResponse
 from .get_dictionary_settings_response import GetDictionarySettingsResponse
 from .get_logs_response import GetLogsResponse
@@ -265,6 +268,9 @@
     "FacetStats",
     "Facets",
     "FetchedIndex",
+    "FetchedIndexAbTest",
+    "FetchedIndexAbTestTarget",
+    "FetchedIndexAbTestVariant",
     "GetApiKeyResponse",
     "GetDictionarySettingsResponse",
     "GetLogsResponse",

algoliasearch/search/models/fetched_index.py

@@ -18,6 +18,8 @@
     from typing_extensions import Self
 
 
+from algoliasearch.search.models.fetched_index_ab_test import FetchedIndexAbTest
+
 _ALIASES = {
     "name": "name",
     "created_at": "createdAt",
@@ -31,6 +33,8 @@
     "primary": "primary",
     "replicas": "replicas",
     "virtual": "virtual",
+    "ab_test": "abTest",
+    "source_ab_test": "sourceABTest",
 }
 
 
@@ -67,6 +71,9 @@ class FetchedIndex(BaseModel):
     """ Only present if the index is a primary index with replicas. Contains the names of all linked replicas. """
     virtual: Optional[bool] = None
     """ Only present if the index is a [virtual replica](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-an-index-alphabetically/#virtual-replicas). """
+    ab_test: Optional[FetchedIndexAbTest] = None
+    source_ab_test: Optional[str] = None
+    """ Name of the index that owns the A/B test configuration. Only present when this index participates in an A/B test configured on another index. """
 
     model_config = ConfigDict(
         strict=False,
@@ -103,4 +110,10 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         if not isinstance(obj, dict):
             return cls.model_validate(obj)
 
+        obj["abTest"] = (
+            FetchedIndexAbTest.from_dict(obj["abTest"])
+            if obj.get("abTest") is not None
+            else None
+        )
+
         return cls.model_validate(obj)

algoliasearch/search/models/fetched_index_ab_test.py

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+"""
+Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+"""
+
+from __future__ import annotations
+
+from json import loads
+from sys import version_info
+from typing import Any, Dict, List, Optional
+
+from pydantic import BaseModel, ConfigDict
+
+if version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
+
+from algoliasearch.search.models.fetched_index_ab_test_target import (
+    FetchedIndexAbTestTarget,
+)
+from algoliasearch.search.models.fetched_index_ab_test_variant import (
+    FetchedIndexAbTestVariant,
+)
+
+_ALIASES = {
+    "id": "id",
+    "is_dark": "isDark",
+    "version": "version",
+    "type": "type",
+    "target": "target",
+    "variants": "variants",
+}
+
+
+def _alias_generator(name: str) -> str:
+    return _ALIASES.get(name, name)
+
+
+class FetchedIndexAbTest(BaseModel):
+    """
+    A/B test metadata. Only present if the index is part of an active A/B test.
+    """
+
+    id: int
+    """ A/B test ID. """
+    is_dark: Optional[bool] = None
+    """ Whether the A/B test is a dark test (server-side measured, not user-facing). Only present when true. """
+    version: Optional[int] = None
+    """ A/B test schema version. Only present for v2 and later tests. """
+    type: Optional[str] = None
+    """ A/B test type. Only present for v2 and later tests. Currently always `index-configuration`. """
+    target: Optional[FetchedIndexAbTestTarget] = None
+    variants: List[FetchedIndexAbTestVariant]
+    """ A/B test variants. """
+
+    model_config = ConfigDict(
+        strict=False,
+        use_enum_values=True,
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+        alias_generator=_alias_generator,
+        extra="allow",
+    )
+
+    def to_json(self) -> str:
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of FetchedIndexAbTest from a JSON string"""
+        return cls.from_dict(loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias."""
+        return self.model_dump(
+            by_alias=True,
+            exclude_none=True,
+            exclude_unset=True,
+        )
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FetchedIndexAbTest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        obj["target"] = (
+            FetchedIndexAbTestTarget.from_dict(obj["target"])
+            if obj.get("target") is not None
+            else None
+        )
+        obj["variants"] = (
+            [FetchedIndexAbTestVariant.from_dict(_item) for _item in obj["variants"]]
+            if obj.get("variants") is not None
+            else None
+        )
+
+        return cls.model_validate(obj)

algoliasearch/search/models/fetched_index_ab_test_target.py

@@ -0,0 +1,73 @@
+# coding: utf-8
+
+"""
+Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+"""
+
+from __future__ import annotations
+
+from json import loads
+from sys import version_info
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel, ConfigDict
+
+if version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
+
+_ALIASES = {
+    "index_name": "indexName",
+}
+
+
+def _alias_generator(name: str) -> str:
+    return _ALIASES.get(name, name)
+
+
+class FetchedIndexAbTestTarget(BaseModel):
+    """
+    A/B test target criteria. Only present for v2 and later tests.
+    """
+
+    index_name: str
+    """ Index name to match. Use `*` to target the entire application. """
+
+    model_config = ConfigDict(
+        strict=False,
+        use_enum_values=True,
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+        alias_generator=_alias_generator,
+        extra="allow",
+    )
+
+    def to_json(self) -> str:
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of FetchedIndexAbTestTarget from a JSON string"""
+        return cls.from_dict(loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias."""
+        return self.model_dump(
+            by_alias=True,
+            exclude_none=True,
+            exclude_unset=True,
+        )
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FetchedIndexAbTestTarget from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        return cls.model_validate(obj)

algoliasearch/search/models/fetched_index_ab_test_variant.py

@@ -0,0 +1,82 @@
+# coding: utf-8
+
+"""
+Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+"""
+
+from __future__ import annotations
+
+from json import loads
+from sys import version_info
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel, ConfigDict
+
+if version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
+
+_ALIASES = {
+    "index_name": "indexName",
+    "percentage": "percentage",
+    "custom_search_parameters": "customSearchParameters",
+    "payload": "payload",
+}
+
+
+def _alias_generator(name: str) -> str:
+    return _ALIASES.get(name, name)
+
+
+class FetchedIndexAbTestVariant(BaseModel):
+    """
+    A/B test variant for an index.
+    """
+
+    index_name: Optional[str] = None
+    """ Index name of the variant. Only present for v0/v1 tests; in v2 this moves into `payload`. """
+    percentage: int
+    """ Percentage of search traffic routed to this variant. """
+    custom_search_parameters: Optional[str] = None
+    """ URL-encoded custom search parameters applied to this variant. Only present for v0/v1 tests; in v2 this moves into `payload`. """
+    payload: Optional[Dict[str, object]] = None
+    """ Type-specific configuration. Only present for v2 and later tests. Shape depends on the parent A/B test's `type`. """
+
+    model_config = ConfigDict(
+        strict=False,
+        use_enum_values=True,
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+        alias_generator=_alias_generator,
+        extra="allow",
+    )
+
+    def to_json(self) -> str:
+        return self.model_dump_json(by_alias=True, exclude_unset=True)
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of FetchedIndexAbTestVariant from a JSON string"""
+        return cls.from_dict(loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias."""
+        return self.model_dump(
+            by_alias=True,
+            exclude_none=True,
+            exclude_unset=True,
+        )
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FetchedIndexAbTestVariant from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        return cls.model_validate(obj)