docs: queryables

CS-SI · Jan 8, 2024 · 6398e50 · 6398e50
1 parent 03fc66f
commit 6398e50
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 3 deletions.
diff --git a/docs/api_reference/core.rst b/docs/api_reference/core.rst
@@ -86,4 +86,4 @@ Misc
    :members: set_preferred_provider, get_preferred_provider, update_providers_config, list_product_types,
              available_providers, search, search_all, search_iter_page, crunch, download, download_all, serialize,
              deserialize, deserialize_and_register, load_stac_items, group_by_extent, guess_product_type, get_cruncher,
-             update_product_types_list, fetch_product_types_list, discover_product_types
+             update_product_types_list, fetch_product_types_list, discover_product_types, list_queryables
diff --git a/docs/api_reference/index.rst b/docs/api_reference/index.rst
@@ -14,4 +14,5 @@ The Python API Reference provides an overview of all public objects, functions a
    eoproduct
    utils
    exceptions
+   types
    call_graphs
diff --git a/docs/api_reference/types.rst b/docs/api_reference/types.rst
@@ -0,0 +1,6 @@
+=====
+Types
+=====
+
+.. automodule:: eodag.types.__init__
+   :members:
diff --git a/eodag/api/core.py b/eodag/api/core.py
@@ -2090,8 +2090,10 @@ def list_queryables(
         :type provider: str
         :param product_type: (optional) The EODAG product type.
         :type product_type: str
-        :returns: A dict containing the EODAG queryable properties.
-        :rtype: dict
+        :returns: A dict containing the EODAG queryable properties, associatiating
+                  parameters to a tuple containings their annotaded type and default
+                  value
+        :rtype: Dict[str, Tuple[Annotated, Any]]
         """
         # unknown product type
         if product_type is not None and product_type not in self.list_product_types(