Add shared dashboard list OpenAPI spec

docs/datadog_api_client.v2.api.rst

@@ -256,6 +256,13 @@ datadog\_api\_client.v2.api.dashboard\_secure\_embed\_api module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.api.dashboard\_sharing\_api module
+----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.api.dashboard_sharing_api
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.api.dashboards\_api module
 --------------------------------------------------
 

docs/datadog_api_client.v2.model.rst

@@ -19716,6 +19716,13 @@ datadog\_api\_client.v2.model.list\_service\_access\_tokens\_response module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.list\_shared\_dashboards\_response module
+-----------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.list_shared_dashboards_response
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.list\_sourcemaps\_response module
 ---------------------------------------------------------------
 
@@ -37104,6 +37111,146 @@ datadog\_api\_client.v2.model.session\_id\_data module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.shared\_dashboard\_global\_time module
+--------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_global_time
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_included module
+----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_included
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_included\_dashboard module
+---------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_included_dashboard
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_included\_dashboard\_attributes module
+---------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_included_dashboard_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_included\_dashboard\_type module
+---------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_included_dashboard_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_included\_user module
+----------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_included_user
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_included\_user\_attributes module
+----------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_included_user_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_invitee module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_invitee
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_relationship\_dashboard module
+-------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_relationship_dashboard
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_relationship\_dashboard\_data module
+-------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_relationship_dashboard_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_relationship\_sharer module
+----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_relationship_sharer
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_relationships module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_relationships
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_response module
+----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_response\_attributes module
+----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_response_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_selectable\_template\_variable module
+--------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_selectable_template_variable
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_share\_type module
+-------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_share_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_status module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_status
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_type module
+------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_viewing\_preferences module
+----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_viewing_preferences
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shared\_dashboard\_viewing\_preferences\_theme module
+-----------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shared_dashboard_viewing_preferences_theme
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.shift module
 ------------------------------------------
 

examples/v2/dashboard-sharing/ListSharedDashboardsByDashboardId.py

@@ -0,0 +1,16 @@
+"""
+List shared dashboards for a dashboard returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.dashboard_sharing_api import DashboardSharingApi
+
+configuration = Configuration()
+configuration.unstable_operations["list_shared_dashboards_by_dashboard_id"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = DashboardSharingApi(api_client)
+    response = api_instance.list_shared_dashboards_by_dashboard_id(
+        dashboard_id="abc-def-ghi",
+    )
+
+    print(response)

src/datadog_api_client/configuration.py

@@ -464,6 +464,7 @@ def __init__(
                 "v2.list_cost_tag_metadata_months": False,
                 "v2.list_cost_tag_metadata_orchestrators": False,
                 "v2.search_cost_recommendations": False,
+                "v2.list_shared_dashboards_by_dashboard_id": False,
                 "v2.create_dashboard_secure_embed": False,
                 "v2.delete_dashboard_secure_embed": False,
                 "v2.get_dashboard_secure_embed": False,

src/datadog_api_client/v2/api/dashboard_sharing_api.py

@@ -0,0 +1,61 @@
+# 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
+
+from datadog_api_client.api_client import ApiClient, Endpoint as _Endpoint
+from datadog_api_client.configuration import Configuration
+from datadog_api_client.v2.model.list_shared_dashboards_response import ListSharedDashboardsResponse
+
+
+class DashboardSharingApi:
+    """
+    Manage dashboard sharing configurations.
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient(Configuration())
+        self.api_client = api_client
+
+        self._list_shared_dashboards_by_dashboard_id_endpoint = _Endpoint(
+            settings={
+                "response_type": (ListSharedDashboardsResponse,),
+                "auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
+                "endpoint_path": "/api/v2/dashboard/{dashboard_id}/shared",
+                "operation_id": "list_shared_dashboards_by_dashboard_id",
+                "http_method": "GET",
+                "version": "v2",
+            },
+            params_map={
+                "dashboard_id": {
+                    "required": True,
+                    "openapi_types": (str,),
+                    "attribute": "dashboard_id",
+                    "location": "path",
+                },
+            },
+            headers_map={
+                "accept": ["application/json"],
+            },
+            api_client=api_client,
+        )
+
+    def list_shared_dashboards_by_dashboard_id(
+        self,
+        dashboard_id: str,
+    ) -> ListSharedDashboardsResponse:
+        """List shared dashboards for a dashboard.
+
+        Retrieve shared dashboards associated with the specified dashboard.
+
+        :param dashboard_id: ID of the dashboard.
+        :type dashboard_id: str
+        :rtype: ListSharedDashboardsResponse
+        """
+        kwargs: Dict[str, Any] = {}
+        kwargs["dashboard_id"] = dashboard_id
+
+        return self._list_shared_dashboards_by_dashboard_id_endpoint.call_with_http_info(**kwargs)

src/datadog_api_client/v2/apis/__init__.py

@@ -35,6 +35,7 @@
 from datadog_api_client.v2.api.dora_metrics_api import DORAMetricsApi
 from datadog_api_client.v2.api.dashboard_lists_api import DashboardListsApi
 from datadog_api_client.v2.api.dashboard_secure_embed_api import DashboardSecureEmbedApi
+from datadog_api_client.v2.api.dashboard_sharing_api import DashboardSharingApi
 from datadog_api_client.v2.api.dashboards_api import DashboardsApi
 from datadog_api_client.v2.api.data_deletion_api import DataDeletionApi
 from datadog_api_client.v2.api.datasets_api import DatasetsApi
@@ -162,6 +163,7 @@
     "DORAMetricsApi",
     "DashboardListsApi",
     "DashboardSecureEmbedApi",
+    "DashboardSharingApi",
     "DashboardsApi",
     "DataDeletionApi",
     "DatasetsApi",

src/datadog_api_client/v2/model/list_shared_dashboards_response.py

@@ -0,0 +1,55 @@
+# 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 List, Union, TYPE_CHECKING
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v2.model.shared_dashboard_response import SharedDashboardResponse
+    from datadog_api_client.v2.model.shared_dashboard_included import SharedDashboardIncluded
+    from datadog_api_client.v2.model.shared_dashboard_included_dashboard import SharedDashboardIncludedDashboard
+    from datadog_api_client.v2.model.shared_dashboard_included_user import SharedDashboardIncludedUser
+
+
+class ListSharedDashboardsResponse(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v2.model.shared_dashboard_response import SharedDashboardResponse
+        from datadog_api_client.v2.model.shared_dashboard_included import SharedDashboardIncluded
+
+        return {
+            "data": ([SharedDashboardResponse],),
+            "included": ([SharedDashboardIncluded],),
+        }
+
+    attribute_map = {
+        "data": "data",
+        "included": "included",
+    }
+
+    def __init__(
+        self_,
+        data: List[SharedDashboardResponse],
+        included: List[Union[SharedDashboardIncluded, SharedDashboardIncludedDashboard, SharedDashboardIncludedUser]],
+        **kwargs,
+    ):
+        """
+        Response containing shared dashboards for a dashboard.
+
+        :param data: Shared dashboards for the dashboard.
+        :type data: [SharedDashboardResponse]
+
+        :param included: Users and dashboards related to the shared dashboards.
+        :type included: [SharedDashboardIncluded]
+        """
+        super().__init__(kwargs)
+
+        self_.data = data
+        self_.included = included

src/datadog_api_client/v2/model/shared_dashboard_global_time.py

@@ -0,0 +1,19 @@
+# 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 datadog_api_client.model_utils import (
+    ModelNormal,
+)
+
+
+class SharedDashboardGlobalTime(ModelNormal):
+    _nullable = True
+
+    def __init__(self_, **kwargs):
+        """
+        Default time range configuration for the shared dashboard.
+        """
+        super().__init__(kwargs)