Add OpenAPI documentation for dashboards and notebooks search endpoints

docs/datadog_api_client.v2.api.rst

@@ -193,6 +193,13 @@ datadog\_api\_client.v2.api.dashboard\_lists\_api module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.api.dashboards\_api module
+--------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.api.dashboards_api
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.api.data\_deletion\_api module
 ------------------------------------------------------
 
@@ -389,6 +396,13 @@ datadog\_api\_client.v2.api.network\_device\_monitoring\_api module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.api.notebooks\_api module
+-------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.api.notebooks_api
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.api.observability\_pipelines\_api module
 ----------------------------------------------------------------
 

docs/datadog_api_client.v2.model.rst

@@ -7116,6 +7116,69 @@ datadog\_api\_client.v2.model.dashboard\_list\_update\_items\_response module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.dashboard\_search\_aggregation\_bucket\_key module
+--------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.dashboard_search_aggregation_bucket_key
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.dashboard\_search\_aggregation\_bucket\_multi\_key module
+---------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.dashboard_search_aggregation_bucket_multi_key
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.dashboard\_search\_aggregations module
+--------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.dashboard_search_aggregations
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.dashboard\_search\_attributes module
+------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.dashboard_search_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.dashboard\_search\_metadata module
+----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.dashboard_search_metadata
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.dashboard\_search\_response module
+----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.dashboard_search_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.dashboard\_search\_response\_meta module
+----------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.dashboard_search_response_meta
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.dashboard\_search\_result\_data module
+--------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.dashboard_search_result_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.dashboard\_search\_user module
+------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.dashboard_search_user
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.dashboard\_trigger\_wrapper module
 ----------------------------------------------------------------
 
@@ -16454,6 +16517,76 @@ datadog\_api\_client.v2.model.ms\_teams\_integration\_metadata\_teams\_item modu
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.notebook\_search\_aggregation\_bucket\_key module
+-------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notebook_search_aggregation_bucket_key
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.notebook\_search\_aggregation\_bucket\_multi\_key module
+--------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notebook_search_aggregation_bucket_multi_key
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.notebook\_search\_aggregations module
+-------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notebook_search_aggregations
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.notebook\_search\_attributes module
+-----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notebook_search_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.notebook\_search\_highlight module
+----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notebook_search_highlight
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.notebook\_search\_metadata module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notebook_search_metadata
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.notebook\_search\_response module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notebook_search_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.notebook\_search\_response\_meta module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notebook_search_response_meta
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.notebook\_search\_result\_data module
+-------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notebook_search_result_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.notebook\_search\_user module
+-----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.notebook_search_user
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.notebook\_trigger\_wrapper module
 ---------------------------------------------------------------
 

examples/v2/dashboards/SearchDashboards.py

@@ -0,0 +1,14 @@
+"""
+Search dashboards returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.dashboards_api import DashboardsApi
+
+configuration = Configuration()
+configuration.unstable_operations["search_dashboards"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = DashboardsApi(api_client)
+    response = api_instance.search_dashboards()
+
+    print(response)

examples/v2/notebooks/SearchNotebooks.py

@@ -0,0 +1,14 @@
+"""
+Search notebooks returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.notebooks_api import NotebooksApi
+
+configuration = Configuration()
+configuration.unstable_operations["search_notebooks"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = NotebooksApi(api_client)
+    response = api_instance.search_notebooks()
+
+    print(response)

src/datadog_api_client/configuration.py

@@ -288,6 +288,7 @@ def __init__(
                 "v2.mute_findings": False,
                 "v2.run_threat_hunting_job": False,
                 "v2.search_security_monitoring_histsignals": False,
+                "v2.search_dashboards": False,
                 "v2.create_dataset": False,
                 "v2.delete_dataset": False,
                 "v2.get_all_datasets": False,
@@ -385,6 +386,7 @@ def __init__(
                 "v2.update_monitor_user_template": False,
                 "v2.validate_existing_monitor_user_template": False,
                 "v2.validate_monitor_user_template": False,
+                "v2.search_notebooks": False,
                 "v2.list_role_templates": False,
                 "v2.create_connection": False,
                 "v2.delete_connection": False,

src/datadog_api_client/v2/api/dashboards_api.py

@@ -0,0 +1,110 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+from typing import Any, Dict, Union
+
+from datadog_api_client.api_client import ApiClient, Endpoint as _Endpoint
+from datadog_api_client.configuration import Configuration
+from datadog_api_client.model_utils import (
+    UnsetType,
+    unset,
+)
+from datadog_api_client.v2.model.dashboard_search_response import DashboardSearchResponse
+
+
+class DashboardsApi:
+    """
+    Interact with your dashboards through the API to search and retrieve dashboards.
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient(Configuration())
+        self.api_client = api_client
+
+        self._search_dashboards_endpoint = _Endpoint(
+            settings={
+                "response_type": (DashboardSearchResponse,),
+                "auth": ["apiKeyAuth", "appKeyAuth"],
+                "endpoint_path": "/api/v2/dashboards/search",
+                "operation_id": "search_dashboards",
+                "http_method": "GET",
+                "version": "v2",
+            },
+            params_map={
+                "query": {
+                    "openapi_types": (str,),
+                    "attribute": "query",
+                    "location": "query",
+                },
+                "sort": {
+                    "openapi_types": (str,),
+                    "attribute": "sort",
+                    "location": "query",
+                },
+                "include": {
+                    "openapi_types": (str,),
+                    "attribute": "include",
+                    "location": "query",
+                },
+                "page": {
+                    "openapi_types": (int,),
+                    "attribute": "page",
+                    "location": "query",
+                },
+                "limit": {
+                    "openapi_types": (int,),
+                    "attribute": "limit",
+                    "location": "query",
+                },
+            },
+            headers_map={
+                "accept": ["application/json"],
+            },
+            api_client=api_client,
+        )
+
+    def search_dashboards(
+        self,
+        *,
+        query: Union[str, UnsetType] = unset,
+        sort: Union[str, UnsetType] = unset,
+        include: Union[str, UnsetType] = unset,
+        page: Union[int, UnsetType] = unset,
+        limit: Union[int, UnsetType] = unset,
+    ) -> DashboardSearchResponse:
+        """Search dashboards.
+
+        Search for dashboards using a query string.
+
+        :param query: Search query string.
+        :type query: str, optional
+        :param sort: Sort field for results.
+        :type sort: str, optional
+        :param include: Additional data to include in the response.
+        :type include: str, optional
+        :param page: Page number for pagination.
+        :type page: int, optional
+        :param limit: Maximum number of results to return.
+        :type limit: int, optional
+        :rtype: DashboardSearchResponse
+        """
+        kwargs: Dict[str, Any] = {}
+        if query is not unset:
+            kwargs["query"] = query
+
+        if sort is not unset:
+            kwargs["sort"] = sort
+
+        if include is not unset:
+            kwargs["include"] = include
+
+        if page is not unset:
+            kwargs["page"] = page
+
+        if limit is not unset:
+            kwargs["limit"] = limit
+
+        return self._search_dashboards_endpoint.call_with_http_info(**kwargs)