Fix Spans endpoint schemas (#1580)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 4e52c63f44ae · 2023-07-14T20:07:03.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-07-14 13:32:03.152627",
-            "spec_repo_commit": "2bd58701"
+            "regenerated": "2023-07-14 14:04:10.985041",
+            "spec_repo_commit": "3868f953"
         },
         "v2": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-07-14 13:32:03.246638",
-            "spec_repo_commit": "2bd58701"
+            "regenerated": "2023-07-14 14:04:11.045806",
+            "spec_repo_commit": "3868f953"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml
@@ -15010,6 +15010,17 @@ components:
           $ref: '#/components/schemas/SpansType'
       type: object
     SpansAggregateBucket:
+      description: Spans aggregate.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/SpansAggregateBucketAttributes'
+        id:
+          description: ID of the spans aggregate.
+          type: string
+        type:
+          $ref: '#/components/schemas/SpansAggregateBucketType'
+      type: object
+    SpansAggregateBucketAttributes:
       description: A bucket values.
       properties:
         by:
@@ -15020,13 +15031,24 @@ components:
             '@state': success
             '@version': abc
           type: object
+        compute:
+          description: The compute data.
+          type: object
         computes:
           additionalProperties:
             $ref: '#/components/schemas/SpansAggregateBucketValue'
           description: A map of the metric name -> value for regular compute or list
             of values for a timeseries.
           type: object
       type: object
+    SpansAggregateBucketType:
+      description: The spans aggregate bucket type.
+      enum:
+      - bucket
+      example: bucket
+      type: string
+      x-enum-varnames:
+      - BUCKET
     SpansAggregateBucketValue:
       description: A bucket value, can be either a timeseries or a single value.
       oneOf:
@@ -15214,6 +15236,10 @@ components:
             customAttribute: 123
             duration: 2345
           type: object
+        custom:
+          additionalProperties: {}
+          description: JSON object of custom spans data.
+          type: object
         end_timestamp:
           description: End timestamp of your span.
           example: '2023-01-02T09:42:36.420Z'
diff --git a/docs/datadog_api_client.v2.model.rst b/docs/datadog_api_client.v2.model.rst
@@ -6728,6 +6728,20 @@ spans\_aggregate\_bucket
    :members:
    :show-inheritance:
 
+spans\_aggregate\_bucket\_attributes
+------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.spans_aggregate_bucket_attributes
+   :members:
+   :show-inheritance:
+
+spans\_aggregate\_bucket\_type
+------------------------------
+
+.. automodule:: datadog_api_client.v2.model.spans_aggregate_bucket_type
+   :members:
+   :show-inheritance:
+
 spans\_aggregate\_bucket\_value
 -------------------------------
 
diff --git a/src/datadog_api_client/v2/model/spans_aggregate_bucket.py b/src/datadog_api_client/v2/model/spans_aggregate_bucket.py
@@ -3,75 +3,62 @@
 # Copyright 2019-Present Datadog, Inc.
 from __future__ import annotations
 
-from typing import Any, Dict, List, Union, TYPE_CHECKING
+from typing import Union, TYPE_CHECKING
 
 from datadog_api_client.model_utils import (
     ModelNormal,
     cached_property,
-    date,
-    datetime,
-    none_type,
     unset,
     UnsetType,
 )
 
 
 if TYPE_CHECKING:
-    from datadog_api_client.v2.model.spans_aggregate_bucket_value import SpansAggregateBucketValue
-    from datadog_api_client.v2.model.spans_aggregate_bucket_value_timeseries_point import (
-        SpansAggregateBucketValueTimeseriesPoint,
-    )
+    from datadog_api_client.v2.model.spans_aggregate_bucket_attributes import SpansAggregateBucketAttributes
+    from datadog_api_client.v2.model.spans_aggregate_bucket_type import SpansAggregateBucketType
 
 
 class SpansAggregateBucket(ModelNormal):
     @cached_property
     def openapi_types(_):
-        from datadog_api_client.v2.model.spans_aggregate_bucket_value import SpansAggregateBucketValue
+        from datadog_api_client.v2.model.spans_aggregate_bucket_attributes import SpansAggregateBucketAttributes
+        from datadog_api_client.v2.model.spans_aggregate_bucket_type import SpansAggregateBucketType
 
         return {
-            "by": (
-                {
-                    str: (
-                        bool,
-                        date,
-                        datetime,
-                        dict,
-                        float,
-                        int,
-                        list,
-                        str,
-                        none_type,
-                    )
-                },
-            ),
-            "computes": ({str: (SpansAggregateBucketValue,)},),
+            "attributes": (SpansAggregateBucketAttributes,),
+            "id": (str,),
+            "type": (SpansAggregateBucketType,),
         }
 
     attribute_map = {
-        "by": "by",
-        "computes": "computes",
+        "attributes": "attributes",
+        "id": "id",
+        "type": "type",
     }
 
     def __init__(
         self_,
-        by: Union[Dict[str, Any], UnsetType] = unset,
-        computes: Union[
-            Dict[str, Union[SpansAggregateBucketValue, str, float, List[SpansAggregateBucketValueTimeseriesPoint]]],
-            UnsetType,
-        ] = unset,
+        attributes: Union[SpansAggregateBucketAttributes, UnsetType] = unset,
+        id: Union[str, UnsetType] = unset,
+        type: Union[SpansAggregateBucketType, UnsetType] = unset,
         **kwargs,
     ):
         """
-        A bucket values.
+        Spans aggregate.
 
-        :param by: The key, value pairs for each group by.
-        :type by: {str: (bool, date, datetime, dict, float, int, list, str, none_type,)}, optional
+        :param attributes: A bucket values.
+        :type attributes: SpansAggregateBucketAttributes, optional
 
-        :param computes: A map of the metric name -> value for regular compute or list of values for a timeseries.
-        :type computes: {str: (SpansAggregateBucketValue,)}, optional
+        :param id: ID of the spans aggregate.
+        :type id: str, optional
+
+        :param type: The spans aggregate bucket type.
+        :type type: SpansAggregateBucketType, optional
         """
-        if by is not unset:
-            kwargs["by"] = by
-        if computes is not unset:
-            kwargs["computes"] = computes
+        if attributes is not unset:
+            kwargs["attributes"] = attributes
+        if id is not unset:
+            kwargs["id"] = id
+        if type is not unset:
+            kwargs["type"] = type
         super().__init__(kwargs)
diff --git a/src/datadog_api_client/v2/model/spans_aggregate_bucket_attributes.py b/src/datadog_api_client/v2/model/spans_aggregate_bucket_attributes.py
@@ -0,0 +1,85 @@
+# 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, List, Union, TYPE_CHECKING
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    date,
+    datetime,
+    none_type,
+    unset,
+    UnsetType,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v2.model.spans_aggregate_bucket_value import SpansAggregateBucketValue
+    from datadog_api_client.v2.model.spans_aggregate_bucket_value_timeseries_point import (
+        SpansAggregateBucketValueTimeseriesPoint,
+    )
+
+
+class SpansAggregateBucketAttributes(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v2.model.spans_aggregate_bucket_value import SpansAggregateBucketValue
+
+        return {
+            "by": (
+                {
+                    str: (
+                        bool,
+                        date,
+                        datetime,
+                        dict,
+                        float,
+                        int,
+                        list,
+                        str,
+                        none_type,
+                    )
+                },
+            ),
+            "compute": (dict,),
+            "computes": ({str: (SpansAggregateBucketValue,)},),
+        }
+
+    attribute_map = {
+        "by": "by",
+        "compute": "compute",
+        "computes": "computes",
+    }
+
+    def __init__(
+        self_,
+        by: Union[Dict[str, Any], UnsetType] = unset,
+        compute: Union[dict, UnsetType] = unset,
+        computes: Union[
+            Dict[str, Union[SpansAggregateBucketValue, str, float, List[SpansAggregateBucketValueTimeseriesPoint]]],
+            UnsetType,
+        ] = unset,
+        **kwargs,
+    ):
+        """
+        A bucket values.
+
+        :param by: The key, value pairs for each group by.
+        :type by: {str: (bool, date, datetime, dict, float, int, list, str, none_type,)}, optional
+
+        :param compute: The compute data.
+        :type compute: dict, optional
+
+        :param computes: A map of the metric name -> value for regular compute or list of values for a timeseries.
+        :type computes: {str: (SpansAggregateBucketValue,)}, optional
+        """
+        if by is not unset:
+            kwargs["by"] = by
+        if compute is not unset:
+            kwargs["compute"] = compute
+        if computes is not unset:
+            kwargs["computes"] = computes
+        super().__init__(kwargs)
diff --git a/src/datadog_api_client/v2/model/spans_aggregate_bucket_type.py b/src/datadog_api_client/v2/model/spans_aggregate_bucket_type.py
@@ -0,0 +1,35 @@
+# 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 (
+    ModelSimple,
+    cached_property,
+)
+
+from typing import ClassVar
+
+
+class SpansAggregateBucketType(ModelSimple):
+    """
+    The spans aggregate bucket type.
+
+    :param value: If omitted defaults to "bucket". Must be one of ["bucket"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "bucket",
+    }
+    BUCKET: ClassVar["SpansAggregateBucketType"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+SpansAggregateBucketType.BUCKET = SpansAggregateBucketType("bucket")
diff --git a/src/datadog_api_client/v2/model/spans_attributes.py b/src/datadog_api_client/v2/model/spans_attributes.py
@@ -35,6 +35,21 @@ def openapi_types(_):
                     )
                 },
             ),
+            "custom": (
+                {
+                    str: (
+                        bool,
+                        date,
+                        datetime,
+                        dict,
+                        float,
+                        int,
+                        list,
+                        str,
+                        none_type,
+                    )
+                },
+            ),
             "end_timestamp": (datetime,),
             "env": (str,),
             "host": (str,),
@@ -54,6 +69,7 @@ def openapi_types(_):
 
     attribute_map = {
         "attributes": "attributes",
+        "custom": "custom",
         "end_timestamp": "end_timestamp",
         "env": "env",
         "host": "host",
@@ -74,6 +90,7 @@ def openapi_types(_):
     def __init__(
         self_,
         attributes: Union[Dict[str, Any], UnsetType] = unset,
+        custom: Union[Dict[str, Any], UnsetType] = unset,
         end_timestamp: Union[datetime, UnsetType] = unset,
         env: Union[str, UnsetType] = unset,
         host: Union[str, UnsetType] = unset,
@@ -97,6 +114,9 @@ def __init__(
         :param attributes: JSON object of attributes from your span.
         :type attributes: {str: (bool, date, datetime, dict, float, int, list, str, none_type,)}, optional
 
+        :param custom: JSON object of custom spans data.
+        :type custom: {str: (bool, date, datetime, dict, float, int, list, str, none_type,)}, optional
+
         :param end_timestamp: End timestamp of your span.
         :type end_timestamp: datetime, optional
 
@@ -146,6 +166,8 @@ def __init__(
         """
         if attributes is not unset:
             kwargs["attributes"] = attributes
+        if custom is not unset:
+            kwargs["custom"] = custom
         if end_timestamp is not unset:
             kwargs["end_timestamp"] = end_timestamp
         if env is not unset:
diff --git a/src/datadog_api_client/v2/models/__init__.py b/src/datadog_api_client/v2/models/__init__.py
@@ -1184,6 +1184,8 @@
 from datadog_api_client.v2.model.slack_integration_metadata_channel_item import SlackIntegrationMetadataChannelItem
 from datadog_api_client.v2.model.span import Span
 from datadog_api_client.v2.model.spans_aggregate_bucket import SpansAggregateBucket
+from datadog_api_client.v2.model.spans_aggregate_bucket_attributes import SpansAggregateBucketAttributes
+from datadog_api_client.v2.model.spans_aggregate_bucket_type import SpansAggregateBucketType
 from datadog_api_client.v2.model.spans_aggregate_bucket_value import SpansAggregateBucketValue
 from datadog_api_client.v2.model.spans_aggregate_bucket_value_timeseries_point import (
     SpansAggregateBucketValueTimeseriesPoint,
@@ -2302,6 +2304,8 @@
     "SlackIntegrationMetadataChannelItem",
     "Span",
     "SpansAggregateBucket",
+    "SpansAggregateBucketAttributes",
+    "SpansAggregateBucketType",
     "SpansAggregateBucketValue",
     "SpansAggregateBucketValueTimeseriesPoint",
     "SpansAggregateData",

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.5",`
`7`		`- "regenerated": "2023-07-14 13:32:03.152627",`
`8`		`- "spec_repo_commit": "2bd58701"`
	`7`	`+ "regenerated": "2023-07-14 14:04:10.985041",`
	`8`	`+ "spec_repo_commit": "3868f953"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.5",`
`12`		`- "regenerated": "2023-07-14 13:32:03.246638",`
`13`		`- "spec_repo_commit": "2bd58701"`
	`12`	`+ "regenerated": "2023-07-14 14:04:11.045806",`
	`13`	`+ "spec_repo_commit": "3868f953"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`