Regenerate client from commit 27106c20 of spec repo

Author: ci.datadog-api-spec

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-09-26 09:51:16.588136",
-            "spec_repo_commit": "24936e30"
+            "regenerated": "2022-09-26 14:13:07.901647",
+            "spec_repo_commit": "27106c20"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-09-26 09:51:16.686609",
-            "spec_repo_commit": "24936e30"
+            "regenerated": "2022-09-26 14:13:07.913199",
+            "spec_repo_commit": "27106c20"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -9270,6 +9270,75 @@ components:
           format: int64
           type: integer
       type: object
+    SLOListWidgetDefinition:
+      description: Use the SLO List widget to track your SLOs (Service Level Objectives)
+        on dashboards.
+      properties:
+        requests:
+          description: Array of one request object to display in the widget.
+          items:
+            $ref: '#/components/schemas/SLOListWidgetRequest'
+          maxItems: 1
+          minItems: 1
+          type: array
+        title:
+          description: Title of the widget.
+          type: string
+        title_align:
+          $ref: '#/components/schemas/WidgetTextAlign'
+        title_size:
+          description: Size of the title.
+          type: string
+        type:
+          $ref: '#/components/schemas/SLOListWidgetDefinitionType'
+      required:
+      - type
+      - requests
+      type: object
+    SLOListWidgetDefinitionType:
+      default: slo_list
+      description: Type of the SLO List widget.
+      enum:
+      - slo_list
+      example: slo_list
+      type: string
+      x-enum-varnames:
+      - SLO_LIST
+    SLOListWidgetQuery:
+      description: Updated SLO List widget.
+      properties:
+        limit:
+          default: 100
+          description: Maximum number of results to display in the table.
+          format: int64
+          maximum: 100
+          minimum: 1
+          type: integer
+        query_string:
+          description: Widget query.
+          example: env:prod AND service:my-app
+          type: string
+      required:
+      - query_string
+      type: object
+    SLOListWidgetRequest:
+      description: Updated SLO List widget.
+      properties:
+        query:
+          $ref: '#/components/schemas/SLOListWidgetQuery'
+        request_type:
+          $ref: '#/components/schemas/SLOListWidgetRequestType'
+      required:
+      - query
+      - request_type
+      type: object
+    SLOListWidgetRequestType:
+      description: Widget request type.
+      enum:
+      - slo_list
+      type: string
+      x-enum-varnames:
+      - SLO_LIST
     SLOOverallStatuses:
       description: Overall status of the SLO by timeframes.
       properties:
@@ -17348,6 +17417,7 @@ components:
       - $ref: '#/components/schemas/QueryValueWidgetDefinition'
       - $ref: '#/components/schemas/ScatterPlotWidgetDefinition'
       - $ref: '#/components/schemas/SLOWidgetDefinition'
+      - $ref: '#/components/schemas/SLOListWidgetDefinition'
       - $ref: '#/components/schemas/ServiceMapWidgetDefinition'
       - $ref: '#/components/schemas/ServiceSummaryWidgetDefinition'
       - $ref: '#/components/schemas/SunburstWidgetDefinition'

docs/datadog_api_client.v1.model.rst

@@ -3039,6 +3039,41 @@ slo\_list\_response\_metadata\_page
    :members:
    :show-inheritance:
 
+slo\_list\_widget\_definition
+-----------------------------
+
+.. automodule:: datadog_api_client.v1.model.slo_list_widget_definition
+   :members:
+   :show-inheritance:
+
+slo\_list\_widget\_definition\_type
+-----------------------------------
+
+.. automodule:: datadog_api_client.v1.model.slo_list_widget_definition_type
+   :members:
+   :show-inheritance:
+
+slo\_list\_widget\_query
+------------------------
+
+.. automodule:: datadog_api_client.v1.model.slo_list_widget_query
+   :members:
+   :show-inheritance:
+
+slo\_list\_widget\_request
+--------------------------
+
+.. automodule:: datadog_api_client.v1.model.slo_list_widget_request
+   :members:
+   :show-inheritance:
+
+slo\_list\_widget\_request\_type
+--------------------------------
+
+.. automodule:: datadog_api_client.v1.model.slo_list_widget_request_type
+   :members:
+   :show-inheritance:
+
 slo\_overall\_statuses
 ----------------------
 

examples/v1/dashboards/CreateDashboard_1423904722.py

@@ -0,0 +1,56 @@
+"""
+Create a new dashboard with slo list widget
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.dashboards_api import DashboardsApi
+from datadog_api_client.v1.model.dashboard import Dashboard
+from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
+from datadog_api_client.v1.model.slo_list_widget_definition import SLOListWidgetDefinition
+from datadog_api_client.v1.model.slo_list_widget_definition_type import SLOListWidgetDefinitionType
+from datadog_api_client.v1.model.slo_list_widget_query import SLOListWidgetQuery
+from datadog_api_client.v1.model.slo_list_widget_request import SLOListWidgetRequest
+from datadog_api_client.v1.model.slo_list_widget_request_type import SLOListWidgetRequestType
+from datadog_api_client.v1.model.widget import Widget
+from datadog_api_client.v1.model.widget_layout import WidgetLayout
+from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign
+
+body = Dashboard(
+    title="Example-Create_a_new_dashboard_with_slo_list_widget",
+    description="",
+    widgets=[
+        Widget(
+            layout=WidgetLayout(
+                x=0,
+                y=0,
+                width=60,
+                height=21,
+            ),
+            definition=SLOListWidgetDefinition(
+                title_size="16",
+                title_align=WidgetTextAlign.LEFT,
+                type=SLOListWidgetDefinitionType.SLO_LIST,
+                requests=[
+                    SLOListWidgetRequest(
+                        query=SLOListWidgetQuery(
+                            query_string="env:prod AND service:my-app",
+                            limit=75,
+                        ),
+                        request_type=SLOListWidgetRequestType.SLO_LIST,
+                    ),
+                ],
+            ),
+        ),
+    ],
+    template_variables=[],
+    layout_type=DashboardLayoutType.FREE,
+    is_read_only=False,
+    notify_list=[],
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = DashboardsApi(api_client)
+    response = api_instance.create_dashboard(body=body)
+
+    print(response)

src/datadog_api_client/v1/model/slo_list_widget_definition.py

@@ -0,0 +1,66 @@
+# 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 datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+)
+
+
+class SLOListWidgetDefinition(ModelNormal):
+    validations = {
+        "requests": {
+            "max_items": 1,
+            "min_items": 1,
+        },
+    }
+
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v1.model.slo_list_widget_request import SLOListWidgetRequest
+        from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign
+        from datadog_api_client.v1.model.slo_list_widget_definition_type import SLOListWidgetDefinitionType
+
+        return {
+            "requests": ([SLOListWidgetRequest],),
+            "title": (str,),
+            "title_align": (WidgetTextAlign,),
+            "title_size": (str,),
+            "type": (SLOListWidgetDefinitionType,),
+        }
+
+    attribute_map = {
+        "requests": "requests",
+        "title": "title",
+        "title_align": "title_align",
+        "title_size": "title_size",
+        "type": "type",
+    }
+
+    def __init__(self_, requests, type, *args, **kwargs):
+        """
+        Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards.
+
+        :param requests: Array of one request object to display in the widget.
+        :type requests: [SLOListWidgetRequest]
+
+        :param title: Title of the widget.
+        :type title: str, optional
+
+        :param title_align: How to align the text on the widget.
+        :type title_align: WidgetTextAlign, optional
+
+        :param title_size: Size of the title.
+        :type title_size: str, optional
+
+        :param type: Type of the SLO List widget.
+        :type type: SLOListWidgetDefinitionType
+        """
+        super().__init__(kwargs)
+
+        self_._check_pos_args(args)
+
+        self_.requests = requests
+        self_.type = type

src/datadog_api_client/v1/model/slo_list_widget_definition_type.py

@@ -0,0 +1,34 @@
+# 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 datadog_api_client.model_utils import (
+    ModelSimple,
+    cached_property,
+)
+
+from typing import ClassVar
+
+
+class SLOListWidgetDefinitionType(ModelSimple):
+    """
+    Type of the SLO List widget.
+
+    :param value: If omitted defaults to "slo_list". Must be one of ["slo_list"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "slo_list",
+    }
+    SLO_LIST: ClassVar["SLOListWidgetDefinitionType"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+SLOListWidgetDefinitionType.SLO_LIST = SLOListWidgetDefinitionType("slo_list")

src/datadog_api_client/v1/model/slo_list_widget_query.py

@@ -0,0 +1,46 @@
+# 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 datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+)
+
+
+class SLOListWidgetQuery(ModelNormal):
+    validations = {
+        "limit": {
+            "inclusive_maximum": 100,
+            "inclusive_minimum": 1,
+        },
+    }
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "limit": (int,),
+            "query_string": (str,),
+        }
+
+    attribute_map = {
+        "limit": "limit",
+        "query_string": "query_string",
+    }
+
+    def __init__(self_, query_string, *args, **kwargs):
+        """
+        Updated SLO List widget.
+
+        :param limit: Maximum number of results to display in the table.
+        :type limit: int, optional
+
+        :param query_string: Widget query.
+        :type query_string: str
+        """
+        super().__init__(kwargs)
+
+        self_._check_pos_args(args)
+
+        self_.query_string = query_string

src/datadog_api_client/v1/model/slo_list_widget_request.py

@@ -0,0 +1,43 @@
+# 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 datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+)
+
+
+class SLOListWidgetRequest(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v1.model.slo_list_widget_query import SLOListWidgetQuery
+        from datadog_api_client.v1.model.slo_list_widget_request_type import SLOListWidgetRequestType
+
+        return {
+            "query": (SLOListWidgetQuery,),
+            "request_type": (SLOListWidgetRequestType,),
+        }
+
+    attribute_map = {
+        "query": "query",
+        "request_type": "request_type",
+    }
+
+    def __init__(self_, query, request_type, *args, **kwargs):
+        """
+        Updated SLO List widget.
+
+        :param query: Updated SLO List widget.
+        :type query: SLOListWidgetQuery
+
+        :param request_type: Widget request type.
+        :type request_type: SLOListWidgetRequestType
+        """
+        super().__init__(kwargs)
+
+        self_._check_pos_args(args)
+
+        self_.query = query
+        self_.request_type = request_type