Update UA API docs to reflect deprecated values for estimated usage types (#2967)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-07-08 19:08:08.429204",
-            "spec_repo_commit": "7b042e12"
+            "regenerated": "2025-07-09 16:47:18.281866",
+            "spec_repo_commit": "d0906173"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-07-08 19:08:08.445031",
-            "spec_repo_commit": "7b042e12"
+            "regenerated": "2025-07-09 16:47:18.298039",
+            "spec_repo_commit": "d0906173"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -4171,7 +4171,10 @@ components:
           type: array
       type: object
     HourlyUsageAttributionUsageType:
-      description: Supported products for hourly usage attribution requests.
+      description: 'Supported products for hourly usage attribution requests.
+
+        The following values have been **deprecated**: `estimated_indexed_spans_usage`,
+        `estimated_ingested_spans_usage`.'
       enum:
       - api_usage
       - apm_fargate_usage
@@ -8535,7 +8538,10 @@ components:
       - SCA_FARGATE_PERCENTAGE
       - ALL
     MonthlyUsageAttributionValues:
-      description: Fields in Usage Summary by tag(s).
+      description: 'Fields in Usage Summary by tag(s).
+
+        The following values have been **deprecated**: `estimated_indexed_spans_usage`,
+        `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`.'
       properties:
         api_percentage:
           description: The percentage of synthetic API test usage by tag(s).
@@ -35406,7 +35412,9 @@ paths:
         schema:
           format: date-time
           type: string
-      - description: Usage type to retrieve.
+      - description: 'Usage type to retrieve. The following values have been **deprecated**:
+
+          `estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.'
         in: query
         name: usage_type
         required: true
@@ -35956,8 +35964,13 @@ paths:
         schema:
           format: date-time
           type: string
-      - description: Comma-separated list of usage types to return, or `*` for all
+      - description: 'Comma-separated list of usage types to return, or `*` for all
           usage types.
+
+          The following values have been **deprecated**:
+
+          `estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`,
+          `estimated_ingested_spans_percentage`.'
         in: query
         name: fields
         required: true
@@ -35969,7 +35982,12 @@ paths:
         required: false
         schema:
           $ref: '#/components/schemas/UsageSortDirection'
-      - description: The field to sort by.
+      - description: 'The field to sort by.
+
+          The following values have been **deprecated**:
+
+          `estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`,
+          `estimated_ingested_spans_percentage`.'
         in: query
         name: sort_name
         required: false

src/main/java/com/datadog/api/client/v1/api/UsageMeteringApi.java

@@ -385,7 +385,9 @@ public GetHourlyUsageAttributionOptionalParameters includeDescendants(
    *
    * @param startHr Datetime in ISO-8601 format, UTC, precise to hour: <code>[YYYY-MM-DDThh]</code>
    *     for usage beginning at this hour. (required)
-   * @param usageType Usage type to retrieve. (required)
+   * @param usageType Usage type to retrieve. The following values have been
+   *     <strong>deprecated</strong>: <code>estimated_indexed_spans_usage</code>, <code>
+   *     estimated_ingested_spans_usage</code>. (required)
    * @return HourlyUsageAttributionResponse
    * @throws ApiException if fails to make API call
    */
@@ -403,7 +405,9 @@ startHr, usageType, new GetHourlyUsageAttributionOptionalParameters())
    *
    * @param startHr Datetime in ISO-8601 format, UTC, precise to hour: <code>[YYYY-MM-DDThh]</code>
    *     for usage beginning at this hour. (required)
-   * @param usageType Usage type to retrieve. (required)
+   * @param usageType Usage type to retrieve. The following values have been
+   *     <strong>deprecated</strong>: <code>estimated_indexed_spans_usage</code>, <code>
+   *     estimated_ingested_spans_usage</code>. (required)
    * @return CompletableFuture&lt;HourlyUsageAttributionResponse&gt;
    */
   public CompletableFuture<HourlyUsageAttributionResponse> getHourlyUsageAttributionAsync(
@@ -423,7 +427,9 @@ startHr, usageType, new GetHourlyUsageAttributionOptionalParameters())
    *
    * @param startHr Datetime in ISO-8601 format, UTC, precise to hour: <code>[YYYY-MM-DDThh]</code>
    *     for usage beginning at this hour. (required)
-   * @param usageType Usage type to retrieve. (required)
+   * @param usageType Usage type to retrieve. The following values have been
+   *     <strong>deprecated</strong>: <code>estimated_indexed_spans_usage</code>, <code>
+   *     estimated_ingested_spans_usage</code>. (required)
    * @param parameters Optional parameters for the request.
    * @return HourlyUsageAttributionResponse
    * @throws ApiException if fails to make API call
@@ -443,7 +449,9 @@ public HourlyUsageAttributionResponse getHourlyUsageAttribution(
    *
    * @param startHr Datetime in ISO-8601 format, UTC, precise to hour: <code>[YYYY-MM-DDThh]</code>
    *     for usage beginning at this hour. (required)
-   * @param usageType Usage type to retrieve. (required)
+   * @param usageType Usage type to retrieve. The following values have been
+   *     <strong>deprecated</strong>: <code>estimated_indexed_spans_usage</code>, <code>
+   *     estimated_ingested_spans_usage</code>. (required)
    * @param parameters Optional parameters for the request.
    * @return CompletableFuture&lt;HourlyUsageAttributionResponse&gt;
    */
@@ -475,7 +483,9 @@ public CompletableFuture<HourlyUsageAttributionResponse> getHourlyUsageAttributi
    *
    * @param startHr Datetime in ISO-8601 format, UTC, precise to hour: <code>[YYYY-MM-DDThh]</code>
    *     for usage beginning at this hour. (required)
-   * @param usageType Usage type to retrieve. (required)
+   * @param usageType Usage type to retrieve. The following values have been
+   *     <strong>deprecated</strong>: <code>estimated_indexed_spans_usage</code>, <code>
+   *     estimated_ingested_spans_usage</code>. (required)
    * @param parameters Optional parameters for the request.
    * @return ApiResponse&lt;HourlyUsageAttributionResponse&gt;
    * @throws ApiException if fails to make API call
@@ -552,7 +562,9 @@ public ApiResponse<HourlyUsageAttributionResponse> getHourlyUsageAttributionWith
    *
    * @param startHr Datetime in ISO-8601 format, UTC, precise to hour: <code>[YYYY-MM-DDThh]</code>
    *     for usage beginning at this hour. (required)
-   * @param usageType Usage type to retrieve. (required)
+   * @param usageType Usage type to retrieve. The following values have been
+   *     <strong>deprecated</strong>: <code>estimated_indexed_spans_usage</code>, <code>
+   *     estimated_ingested_spans_usage</code>. (required)
    * @param parameters Optional parameters for the request.
    * @return CompletableFuture&lt;ApiResponse&lt;HourlyUsageAttributionResponse&gt;&gt;
    */
@@ -1352,7 +1364,10 @@ public GetMonthlyUsageAttributionOptionalParameters sortDirection(
     /**
      * Set sortName.
      *
-     * @param sortName The field to sort by. (optional)
+     * @param sortName The field to sort by. The following values have been
+     *     <strong>deprecated</strong>: <code>estimated_indexed_spans_usage</code>, <code>
+     *     estimated_indexed_spans_percentage</code>, <code>estimated_ingested_spans_usage</code>,
+     *     <code>estimated_ingested_spans_percentage</code>. (optional)
      * @return GetMonthlyUsageAttributionOptionalParameters
      */
     public GetMonthlyUsageAttributionOptionalParameters sortName(
@@ -1408,7 +1423,10 @@ public GetMonthlyUsageAttributionOptionalParameters includeDescendants(
    * @param startMonth Datetime in ISO-8601 format, UTC, precise to month: <code>[YYYY-MM]</code>
    *     for usage beginning in this month. Maximum of 15 months ago. (required)
    * @param fields Comma-separated list of usage types to return, or <code>*</code> for all usage
-   *     types. (required)
+   *     types. The following values have been <strong>deprecated</strong>: <code>
+   *     estimated_indexed_spans_usage</code>, <code>estimated_indexed_spans_percentage</code>,
+   *     <code>estimated_ingested_spans_usage</code>, <code>estimated_ingested_spans_percentage
+   *     </code>. (required)
    * @return MonthlyUsageAttributionResponse
    * @throws ApiException if fails to make API call
    */
@@ -1428,7 +1446,10 @@ startMonth, fields, new GetMonthlyUsageAttributionOptionalParameters())
    * @param startMonth Datetime in ISO-8601 format, UTC, precise to month: <code>[YYYY-MM]</code>
    *     for usage beginning in this month. Maximum of 15 months ago. (required)
    * @param fields Comma-separated list of usage types to return, or <code>*</code> for all usage
-   *     types. (required)
+   *     types. The following values have been <strong>deprecated</strong>: <code>
+   *     estimated_indexed_spans_usage</code>, <code>estimated_indexed_spans_percentage</code>,
+   *     <code>estimated_ingested_spans_usage</code>, <code>estimated_ingested_spans_percentage
+   *     </code>. (required)
    * @return CompletableFuture&lt;MonthlyUsageAttributionResponse&gt;
    */
   public CompletableFuture<MonthlyUsageAttributionResponse> getMonthlyUsageAttributionAsync(
@@ -1449,7 +1470,10 @@ startMonth, fields, new GetMonthlyUsageAttributionOptionalParameters())
    * @param startMonth Datetime in ISO-8601 format, UTC, precise to month: <code>[YYYY-MM]</code>
    *     for usage beginning in this month. Maximum of 15 months ago. (required)
    * @param fields Comma-separated list of usage types to return, or <code>*</code> for all usage
-   *     types. (required)
+   *     types. The following values have been <strong>deprecated</strong>: <code>
+   *     estimated_indexed_spans_usage</code>, <code>estimated_indexed_spans_percentage</code>,
+   *     <code>estimated_ingested_spans_usage</code>, <code>estimated_ingested_spans_percentage
+   *     </code>. (required)
    * @param parameters Optional parameters for the request.
    * @return MonthlyUsageAttributionResponse
    * @throws ApiException if fails to make API call
@@ -1470,7 +1494,10 @@ public MonthlyUsageAttributionResponse getMonthlyUsageAttribution(
    * @param startMonth Datetime in ISO-8601 format, UTC, precise to month: <code>[YYYY-MM]</code>
    *     for usage beginning in this month. Maximum of 15 months ago. (required)
    * @param fields Comma-separated list of usage types to return, or <code>*</code> for all usage
-   *     types. (required)
+   *     types. The following values have been <strong>deprecated</strong>: <code>
+   *     estimated_indexed_spans_usage</code>, <code>estimated_indexed_spans_percentage</code>,
+   *     <code>estimated_ingested_spans_usage</code>, <code>estimated_ingested_spans_percentage
+   *     </code>. (required)
    * @param parameters Optional parameters for the request.
    * @return CompletableFuture&lt;MonthlyUsageAttributionResponse&gt;
    */
@@ -1503,7 +1530,10 @@ public CompletableFuture<MonthlyUsageAttributionResponse> getMonthlyUsageAttribu
    * @param startMonth Datetime in ISO-8601 format, UTC, precise to month: <code>[YYYY-MM]</code>
    *     for usage beginning in this month. Maximum of 15 months ago. (required)
    * @param fields Comma-separated list of usage types to return, or <code>*</code> for all usage
-   *     types. (required)
+   *     types. The following values have been <strong>deprecated</strong>: <code>
+   *     estimated_indexed_spans_usage</code>, <code>estimated_indexed_spans_percentage</code>,
+   *     <code>estimated_ingested_spans_usage</code>, <code>estimated_ingested_spans_percentage
+   *     </code>. (required)
    * @param parameters Optional parameters for the request.
    * @return ApiResponse&lt;MonthlyUsageAttributionResponse&gt;
    * @throws ApiException if fails to make API call
@@ -1586,7 +1616,10 @@ public ApiResponse<MonthlyUsageAttributionResponse> getMonthlyUsageAttributionWi
    * @param startMonth Datetime in ISO-8601 format, UTC, precise to month: <code>[YYYY-MM]</code>
    *     for usage beginning in this month. Maximum of 15 months ago. (required)
    * @param fields Comma-separated list of usage types to return, or <code>*</code> for all usage
-   *     types. (required)
+   *     types. The following values have been <strong>deprecated</strong>: <code>
+   *     estimated_indexed_spans_usage</code>, <code>estimated_indexed_spans_percentage</code>,
+   *     <code>estimated_ingested_spans_usage</code>, <code>estimated_ingested_spans_percentage
+   *     </code>. (required)
    * @param parameters Optional parameters for the request.
    * @return CompletableFuture&lt;ApiResponse&lt;MonthlyUsageAttributionResponse&gt;&gt;
    */

src/main/java/com/datadog/api/client/v1/model/HourlyUsageAttributionBody.java

@@ -270,7 +270,9 @@ public HourlyUsageAttributionBody usageType(HourlyUsageAttributionUsageType usag
   }
 
   /**
-   * Supported products for hourly usage attribution requests.
+   * Supported products for hourly usage attribution requests. The following values have been
+   * <strong>deprecated</strong>: <code>estimated_indexed_spans_usage</code>, <code>
+   * estimated_ingested_spans_usage</code>.
    *
    * @return usageType
    */

src/main/java/com/datadog/api/client/v1/model/HourlyUsageAttributionUsageType.java

@@ -18,7 +18,11 @@
 import java.util.HashSet;
 import java.util.Set;
 
-/** Supported products for hourly usage attribution requests. */
+/**
+ * Supported products for hourly usage attribution requests. The following values have been
+ * <strong>deprecated</strong>: <code>estimated_indexed_spans_usage</code>, <code>
+ * estimated_ingested_spans_usage</code>.
+ */
 @JsonSerialize(
     using = HourlyUsageAttributionUsageType.HourlyUsageAttributionUsageTypeSerializer.class)
 public class HourlyUsageAttributionUsageType extends ModelEnum<String> {

src/main/java/com/datadog/api/client/v1/model/MonthlyUsageAttributionBody.java

@@ -244,7 +244,9 @@ public MonthlyUsageAttributionBody values(MonthlyUsageAttributionValues values)
   }
 
   /**
-   * Fields in Usage Summary by tag(s).
+   * Fields in Usage Summary by tag(s). The following values have been <strong>deprecated</strong>:
+   * <code>estimated_indexed_spans_usage</code>, <code>estimated_indexed_spans_percentage</code>,
+   * <code>estimated_ingested_spans_usage</code>, <code>estimated_ingested_spans_percentage</code>.
    *
    * @return values
    */

src/main/java/com/datadog/api/client/v1/model/MonthlyUsageAttributionValues.java

@@ -16,7 +16,11 @@
 import java.util.Map;
 import java.util.Objects;
 
-/** Fields in Usage Summary by tag(s). */
+/**
+ * Fields in Usage Summary by tag(s). The following values have been <strong>deprecated</strong>:
+ * <code>estimated_indexed_spans_usage</code>, <code>estimated_indexed_spans_percentage</code>,
+ * <code>estimated_ingested_spans_usage</code>, <code>estimated_ingested_spans_percentage</code>.
+ */
 @JsonPropertyOrder({
   MonthlyUsageAttributionValues.JSON_PROPERTY_API_PERCENTAGE,
   MonthlyUsageAttributionValues.JSON_PROPERTY_API_USAGE,