Add missing descriptions to v1 spec schemas and properties

.generator/schemas/v1/openapi.yaml

@@ -2782,6 +2782,7 @@ components:
         peer_tags:
           description: Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.).
           items:
+            description: A tag identifying a specific downstream entity (e.g. peer.service, peer.db_instance).
             example: "peer.service:my-service"
             type: string
           type: array
@@ -6647,6 +6648,7 @@ components:
         sources:
           additionalProperties:
             items:
+              description: A fallback source attribute name.
               type: string
             type: array
           description: Fallback sources used to populate value of field.
@@ -6695,6 +6697,7 @@ components:
           description: Optional list of profiles to modify the schema.
           example: ["security_control", "host"]
           items:
+            description: A profile name that modifies the schema behavior.
             type: string
           type: array
         schema_type:
@@ -7730,25 +7733,13 @@ components:
         - L2NORM
         - PERCENTILE
         - STDDEV
-    MonitorFormulaAndFunctionCostDataSource:
-      description: Data source for cost queries.
-      enum:
-        - metrics
-        - cloud_cost
-        - datadog_usage
-      example: "cloud_cost"
-      type: string
-      x-enum-varnames:
-        - METRICS
-        - CLOUD_COST
-        - DATADOG_USAGE
     MonitorFormulaAndFunctionCostQueryDefinition:
       description: A formula and functions cost query.
       properties:
         aggregator:
           $ref: "#/components/schemas/MonitorFormulaAndFunctionCostAggregator"
         data_source:
-          $ref: "#/components/schemas/MonitorFormulaAndFunctionCostDataSource"
+          $ref: "#/components/schemas/MonitorFormulaAndFunctionMetricsDataSource"
         name:
           description: Name of the query for use in formulas.
           example: "query1"
@@ -7808,6 +7799,7 @@ components:
           description: Columns to group results by.
           example: ["col1", "col2"]
           items:
+            description: A column name to group results by.
             type: string
           type: array
         model_type_override:
@@ -7827,6 +7819,7 @@ components:
           description: Optional grouping fields for aggregation.
           example: ["entity_id"]
           items:
+            description: A field name to group results by.
             type: string
           type: array
         measure:
@@ -11161,8 +11154,10 @@ components:
       description: Product Analytics audience account subquery.
       properties:
         name:
+          description: The name of the account subquery.
           type: string
         query:
+          description: The query string for the account subquery.
           type: string
       type: object
     ProductAnalyticsAudienceFilters:
@@ -11173,6 +11168,7 @@ components:
             $ref: "#/components/schemas/ProductAnalyticsAudienceAccountSubquery"
           type: array
         filter_condition:
+          description: An optional filter condition applied to the audience subquery.
           type: string
         segments:
           items:
@@ -11184,26 +11180,33 @@ components:
           type: array
       type: object
     ProductAnalyticsAudienceOccurrenceFilter:
+      description: Filter applied to occurrence counts when building a Product Analytics audience.
       properties:
         operator:
+          description: The comparison operator used for the occurrence filter (e.g. `gt`, `lt`, `eq`).
           type: string
         value:
+          description: The threshold value to compare occurrence counts against.
           type: string
       type: object
     ProductAnalyticsAudienceSegmentSubquery:
       description: Product Analytics audience segment subquery.
       properties:
         name:
+          description: The name of the segment subquery.
           type: string
         segment_id:
+          description: The unique identifier of the segment.
           type: string
       type: object
     ProductAnalyticsAudienceUserSubquery:
       description: Product Analytics audience user subquery.
       properties:
         name:
+          description: The name of the user subquery.
           type: string
         query:
+          description: The query string for the user subquery.
           type: string
       type: object
     QuerySortOrder:
@@ -11772,6 +11775,7 @@ components:
         - $ref: "#/components/schemas/SLOCountDefinitionWithBadEventsFormula"
     SLOCountDefinitionWithBadEventsFormula:
       additionalProperties: false
+      description: SLO count definition using a bad events formula alongside a good events formula.
       properties:
         bad_events_formula:
           $ref: "#/components/schemas/SLOFormula"
@@ -11798,6 +11802,7 @@ components:
       type: object
     SLOCountDefinitionWithTotalEventsFormula:
       additionalProperties: false
+      description: SLO count definition using a total events formula alongside a good events formula.
       properties:
         good_events_formula:
           $ref: "#/components/schemas/SLOFormula"
@@ -13004,6 +13009,7 @@ components:
           description: Fields to group by.
           example: ["source", "destination"]
           items:
+            description: A field name to group by.
             type: string
           type: array
         limit:
@@ -13626,6 +13632,7 @@ components:
             Always included in service level objective responses (but may be empty).
           example: ["env:prod", "app:core"]
           items:
+            description: A tag associated with the service level objective.
             type: string
           type: array
         created_at:
@@ -13649,6 +13656,7 @@ components:
         env_tags:
           description: Tags with the `env` tag key.
           items:
+            description: A tag with the `env` tag key.
             type: string
           type: array
         groups:
@@ -13693,6 +13701,7 @@ components:
         service_tags:
           description: Tags with the `service` tag key.
           items:
+            description: A tag with the `service` tag key.
             type: string
           type: array
         slo_type:
@@ -13702,6 +13711,7 @@ components:
         team_tags:
           description: Tags with the `team` tag key.
           items:
+            description: A tag with the `team` tag key.
             type: string
           type: array
         thresholds:
@@ -14712,6 +14722,7 @@ components:
           description: The tag values.
           example: ["env"]
           items:
+            description: A tag value string.
             minLength: 1
             type: string
           type: array
@@ -17989,6 +18000,7 @@ components:
         blockedRequestPatterns:
           description: Array of URL patterns to block.
           items:
+            description: A URL pattern to block during the Synthetic test.
             type: string
           type: array
         checkCertificateRevocation:

docs/datadog_api_client.v1.model.rst

@@ -2489,13 +2489,6 @@ datadog\_api\_client.v1.model.monitor\_formula\_and\_function\_cost\_aggregator
    :members:
    :show-inheritance:
 
-datadog\_api\_client.v1.model.monitor\_formula\_and\_function\_cost\_data\_source module
-----------------------------------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v1.model.monitor_formula_and_function_cost_data_source
-   :members:
-   :show-inheritance:
-
 datadog\_api\_client.v1.model.monitor\_formula\_and\_function\_cost\_query\_definition module
 ---------------------------------------------------------------------------------------------
 

examples/v1/monitors/CreateMonitor_1303514967.py

@@ -8,12 +8,12 @@
 from datadog_api_client.v1.model.monitor_formula_and_function_cost_aggregator import (
     MonitorFormulaAndFunctionCostAggregator,
 )
-from datadog_api_client.v1.model.monitor_formula_and_function_cost_data_source import (
-    MonitorFormulaAndFunctionCostDataSource,
-)
 from datadog_api_client.v1.model.monitor_formula_and_function_cost_query_definition import (
     MonitorFormulaAndFunctionCostQueryDefinition,
 )
+from datadog_api_client.v1.model.monitor_formula_and_function_metrics_data_source import (
+    MonitorFormulaAndFunctionMetricsDataSource,
+)
 from datadog_api_client.v1.model.monitor_options import MonitorOptions
 from datadog_api_client.v1.model.monitor_thresholds import MonitorThresholds
 from datadog_api_client.v1.model.monitor_type import MonitorType
@@ -35,7 +35,7 @@
         ),
         variables=[
             MonitorFormulaAndFunctionCostQueryDefinition(
-                data_source=MonitorFormulaAndFunctionCostDataSource.CLOUD_COST,
+                data_source=MonitorFormulaAndFunctionMetricsDataSource.CLOUD_COST,
                 query="sum:aws.cost.net.amortized.shared.resources.allocated{aws_product IN (amplify ,athena, backup, bedrock ) } by {aws_product}.rollup(sum, 86400)",
                 name="query1",
                 aggregator=MonitorFormulaAndFunctionCostAggregator.SUM,

src/datadog_api_client/v1/model/monitor_formula_and_function_cost_query_definition.py

@@ -17,8 +17,8 @@
     from datadog_api_client.v1.model.monitor_formula_and_function_cost_aggregator import (
         MonitorFormulaAndFunctionCostAggregator,
     )
-    from datadog_api_client.v1.model.monitor_formula_and_function_cost_data_source import (
-        MonitorFormulaAndFunctionCostDataSource,
+    from datadog_api_client.v1.model.monitor_formula_and_function_metrics_data_source import (
+        MonitorFormulaAndFunctionMetricsDataSource,
     )
 
 
@@ -28,13 +28,13 @@ def openapi_types(_):
         from datadog_api_client.v1.model.monitor_formula_and_function_cost_aggregator import (
             MonitorFormulaAndFunctionCostAggregator,
         )
-        from datadog_api_client.v1.model.monitor_formula_and_function_cost_data_source import (
-            MonitorFormulaAndFunctionCostDataSource,
+        from datadog_api_client.v1.model.monitor_formula_and_function_metrics_data_source import (
+            MonitorFormulaAndFunctionMetricsDataSource,
         )
 
         return {
             "aggregator": (MonitorFormulaAndFunctionCostAggregator,),
-            "data_source": (MonitorFormulaAndFunctionCostDataSource,),
+            "data_source": (MonitorFormulaAndFunctionMetricsDataSource,),
             "name": (str,),
             "query": (str,),
         }
@@ -48,7 +48,7 @@ def openapi_types(_):
 
     def __init__(
         self_,
-        data_source: MonitorFormulaAndFunctionCostDataSource,
+        data_source: MonitorFormulaAndFunctionMetricsDataSource,
         name: str,
         query: str,
         aggregator: Union[MonitorFormulaAndFunctionCostAggregator, UnsetType] = unset,
@@ -60,8 +60,8 @@ def __init__(
         :param aggregator: Aggregation methods for metric queries.
         :type aggregator: MonitorFormulaAndFunctionCostAggregator, optional
 
-        :param data_source: Data source for cost queries.
-        :type data_source: MonitorFormulaAndFunctionCostDataSource
+        :param data_source: Data source for metrics queries.
+        :type data_source: MonitorFormulaAndFunctionMetricsDataSource
 
         :param name: Name of the query for use in formulas.
         :type name: str

src/datadog_api_client/v1/model/product_analytics_audience_account_subquery.py

@@ -30,10 +30,10 @@ def __init__(self_, name: Union[str, UnsetType] = unset, query: Union[str, Unset
         """
         Product Analytics audience account subquery.
 
-        :param name:
+        :param name: The name of the account subquery.
         :type name: str, optional
 
-        :param query:
+        :param query: The query string for the account subquery.
         :type query: str, optional
         """
         if name is not unset:

src/datadog_api_client/v1/model/product_analytics_audience_filters.py

@@ -66,7 +66,7 @@ def __init__(
         :param accounts:
         :type accounts: [ProductAnalyticsAudienceAccountSubquery], optional
 
-        :param filter_condition:
+        :param filter_condition: An optional filter condition applied to the audience subquery.
         :type filter_condition: str, optional
 
         :param segments:

src/datadog_api_client/v1/model/product_analytics_audience_occurrence_filter.py

@@ -28,12 +28,12 @@ def openapi_types(_):
 
     def __init__(self_, operator: Union[str, UnsetType] = unset, value: Union[str, UnsetType] = unset, **kwargs):
         """
+        Filter applied to occurrence counts when building a Product Analytics audience.
 
-
-        :param operator:
+        :param operator: The comparison operator used for the occurrence filter (e.g. ``gt`` , ``lt`` , ``eq`` ).
         :type operator: str, optional
 
-        :param value:
+        :param value: The threshold value to compare occurrence counts against.
         :type value: str, optional
         """
         if operator is not unset:

src/datadog_api_client/v1/model/product_analytics_audience_segment_subquery.py

@@ -30,10 +30,10 @@ def __init__(self_, name: Union[str, UnsetType] = unset, segment_id: Union[str,
         """
         Product Analytics audience segment subquery.
 
-        :param name:
+        :param name: The name of the segment subquery.
         :type name: str, optional
 
-        :param segment_id:
+        :param segment_id: The unique identifier of the segment.
         :type segment_id: str, optional
         """
         if name is not unset:

src/datadog_api_client/v1/model/product_analytics_audience_user_subquery.py

@@ -30,10 +30,10 @@ def __init__(self_, name: Union[str, UnsetType] = unset, query: Union[str, Unset
         """
         Product Analytics audience user subquery.
 
-        :param name:
+        :param name: The name of the user subquery.
         :type name: str, optional
 
-        :param query:
+        :param query: The query string for the user subquery.
         :type query: str, optional
         """
         if name is not unset:

src/datadog_api_client/v1/model/sankey_rum_query.py

@@ -102,7 +102,7 @@ def __init__(
         :param number_of_steps: Number of steps.
         :type number_of_steps: int, optional
 
-        :param occurrences:
+        :param occurrences: Filter applied to occurrence counts when building a Product Analytics audience.
         :type occurrences: ProductAnalyticsAudienceOccurrenceFilter, optional
 
         :param query_string: Query string.