feat(specs): add facets query parameter available at run time (generated)

algolia/api-clients-automation#5486

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Clara Muller <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>

Author: 3 people

algoliasearch/composition/models/__init__.py

@@ -52,14 +52,14 @@
 from .facet_hits import FacetHits
 from .facet_ordering import FacetOrdering
 from .facet_stats import FacetStats
-from .facets import Facets
 from .get_task_response import GetTaskResponse
 from .highlight_result import HighlightResult
 from .highlight_result_option import HighlightResultOption
 from .hit import Hit
 from .hit_metadata import HitMetadata
 from .hit_ranking_info import HitRankingInfo
 from .ignore_plurals import IgnorePlurals
+from .index_settings_facets import IndexSettingsFacets
 from .injected_item import InjectedItem
 from .injected_item_hits_metadata import InjectedItemHitsMetadata
 from .injected_item_metadata import InjectedItemMetadata
@@ -163,14 +163,14 @@
     "FacetHits",
     "FacetOrdering",
     "FacetStats",
-    "Facets",
     "GetTaskResponse",
     "HighlightResult",
     "HighlightResultOption",
     "Hit",
     "HitMetadata",
     "HitRankingInfo",
     "IgnorePlurals",
+    "IndexSettingsFacets",
     "InjectedItem",
     "InjectedItemHitsMetadata",
     "InjectedItemMetadata",

algoliasearch/composition/models/facet_ordering.py

@@ -18,7 +18,7 @@
     from typing_extensions import Self
 
 
-from algoliasearch.composition.models.facets import Facets
+from algoliasearch.composition.models.index_settings_facets import IndexSettingsFacets
 from algoliasearch.composition.models.value import Value
 
 _ALIASES = {
@@ -36,7 +36,7 @@ class FacetOrdering(BaseModel):
     Order of facet names and facet values in your UI.
     """
 
-    facets: Optional[Facets] = None
+    facets: Optional[IndexSettingsFacets] = None
     values: Optional[Dict[str, Value]] = None
     """ Order of facet values. One object for each facet. """
 
@@ -76,7 +76,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             return cls.model_validate(obj)
 
         obj["facets"] = (
-            Facets.from_dict(obj["facets"]) if obj.get("facets") is not None else None
+            IndexSettingsFacets.from_dict(obj["facets"])
+            if obj.get("facets") is not None
+            else None
         )
         obj["values"] = (
             dict((_k, Value.from_dict(_v)) for _k, _v in obj["values"].items())

algoliasearch/composition/models/facets.py renamed to algoliasearch/composition/models/index_settings_facets.py

@@ -27,7 +27,7 @@ def _alias_generator(name: str) -> str:
     return _ALIASES.get(name, name)
 
 
-class Facets(BaseModel):
+class IndexSettingsFacets(BaseModel):
     """
     Order of facet names.
     """
@@ -50,7 +50,7 @@ def to_json(self) -> str:
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of Facets from a JSON string"""
+        """Create an instance of IndexSettingsFacets from a JSON string"""
         return cls.from_dict(loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -63,7 +63,7 @@ def to_dict(self) -> Dict[str, Any]:
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of Facets from a dict"""
+        """Create an instance of IndexSettingsFacets from a dict"""
         if obj is None:
             return None
 

algoliasearch/composition/models/params.py

@@ -33,6 +33,7 @@
     "page": "page",
     "get_ranking_info": "getRankingInfo",
     "relevancy_strictness": "relevancyStrictness",
+    "facets": "facets",
     "facet_filters": "facetFilters",
     "optional_filters": "optionalFilters",
     "numeric_filters": "numericFilters",
@@ -77,6 +78,8 @@ class Params(BaseModel):
     """ Whether the run response should include detailed ranking information. """
     relevancy_strictness: Optional[int] = None
     """ Relevancy threshold below which less relevant results aren't included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.  """
+    facets: Optional[List[str]] = None
+    """ Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).  """
     facet_filters: Optional[FacetFilters] = None
     optional_filters: Optional[OptionalFilters] = None
     numeric_filters: Optional[NumericFilters] = None