Clarify which usage API endpoints must be called using root org keys (#1946)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-04-19 13:48:50.974867",
-            "spec_repo_commit": "d5fb4450"
+            "regenerated": "2024-04-19 20:49:45.386499",
+            "spec_repo_commit": "c3db9ec1"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-04-19 13:48:50.992732",
-            "spec_repo_commit": "d5fb4450"
+            "regenerated": "2024-04-19 20:49:45.403012",
+            "spec_repo_commit": "c3db9ec1"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -30958,7 +30958,10 @@ paths:
       - Usage Metering
   /api/v1/usage/billable-summary:
     get:
-      description: Get billable usage across your account.
+      description: 'Get billable usage across your account.
+
+
+        This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).'
       operationId: GetUsageBillableSummary
       parameters:
       - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
@@ -32489,7 +32492,10 @@ paths:
       - Usage Metering
   /api/v1/usage/summary:
     get:
-      description: Get all usage across your account.
+      description: 'Get all usage across your account.
+
+
+        This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).'
       operationId: GetUsageSummary
       parameters:
       - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
@@ -33568,8 +33574,6 @@ tags:
 
     This API is available to all Pro and Enterprise customers.
 
-    Usage is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).
-
 
     **Note**: Usage data is delayed by up to 72 hours from when it was incurred.
 

.generator/schemas/v2/openapi.yaml

@@ -25314,7 +25314,8 @@ paths:
         end_month)\ncursor := response.metadata.pagination.next_record_id\nWHILE cursor
         != null BEGIN\n  sleep(5 seconds)  # Avoid running into rate limit\n  response
         := GetMonthlyCostAttribution(start_month, end_month, next_record_id=cursor)\n
-        \ cursor := response.metadata.pagination.next_record_id\nEND\n```"
+        \ cursor := response.metadata.pagination.next_record_id\nEND\n```\n\nThis
+        endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/)."
       operationId: GetMonthlyCostAttribution
       parameters:
       - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
@@ -35214,7 +35215,10 @@ paths:
 
         [`/historical_cost`](https://docs.datadoghq.com/api/latest/usage-metering/#get-historical-cost-across-your-account)
 
-        instead.'
+        instead.
+
+
+        This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).'
       operationId: GetCostByOrg
       parameters:
       - description: 'Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]`
@@ -35274,7 +35278,10 @@ paths:
 
         and is delayed by up to 72 hours from when it was incurred.
 
-        To access historical costs prior to this, use the `/historical_cost` endpoint.'
+        To access historical costs prior to this, use the `/historical_cost` endpoint.
+
+
+        This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).'
       operationId: GetEstimatedCostByOrg
       parameters:
       - description: String to specify whether cost is broken down at a parent-org
@@ -35359,7 +35366,10 @@ paths:
       description: 'Get historical cost across multi-org and single root-org accounts.
 
         Cost data for a given month becomes available no later than the 16th of the
-        following month.'
+        following month.
+
+
+        This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).'
       operationId: GetHistoricalCostByOrg
       parameters:
       - description: String to specify whether cost is broken down at a parent-org
@@ -35671,7 +35681,8 @@ paths:
         Projected cost data is only available for the current month and becomes available
         around the 12th of the month.
 
-        This endpoint requires the usage_read authorization scope.'
+
+        This endpoint is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).'
       operationId: GetProjectedCost
       parameters:
       - description: String to specify whether cost is broken down at a parent-org
@@ -36502,8 +36513,6 @@ tags:
 
     This API is available to all Pro and Enterprise customers.
 
-    Usage is only accessible for [parent-level organizations](https://docs.datadoghq.com/account_management/multi_organization/).
-
 
     **Note**: Usage data is delayed by up to 72 hours from when it was incurred.
 

src/datadog_api_client/v1/api/usage_metering_api.py

@@ -63,7 +63,6 @@ class UsageMeteringApi:
     The usage metering API allows you to get hourly, daily, and
     monthly usage across multiple facets of Datadog.
     This API is available to all Pro and Enterprise customers.
-    Usage is only accessible for `parent-level organizations <https://docs.datadoghq.com/account_management/multi_organization/>`_.
 
     **Note** : Usage data is delayed by up to 72 hours from when it was incurred.
     It is retained for 15 months.
@@ -1580,6 +1579,8 @@ def get_usage_billable_summary(
 
         Get billable usage across your account.
 
+        This endpoint is only accessible for `parent-level organizations <https://docs.datadoghq.com/account_management/multi_organization/>`_.
+
         :param month: Datetime in ISO-8601 format, UTC, precise to month: ``[YYYY-MM]`` for usage starting this month.
         :type month: datetime, optional
         :rtype: UsageBillableSummaryResponse
@@ -2142,6 +2143,8 @@ def get_usage_summary(
 
         Get all usage across your account.
 
+        This endpoint is only accessible for `parent-level organizations <https://docs.datadoghq.com/account_management/multi_organization/>`_.
+
         :param start_month: Datetime in ISO-8601 format, UTC, precise to month: ``[YYYY-MM]`` for usage beginning in this month.
             Maximum of 15 months ago.
         :type start_month: datetime

src/datadog_api_client/v2/api/usage_metering_api.py

@@ -31,7 +31,6 @@ class UsageMeteringApi:
     The usage metering API allows you to get hourly, daily, and
     monthly usage across multiple facets of Datadog.
     This API is available to all Pro and Enterprise customers.
-    Usage is only accessible for `parent-level organizations <https://docs.datadoghq.com/account_management/multi_organization/>`_.
 
     **Note** : Usage data is delayed by up to 72 hours from when it was incurred.
     It is retained for 15 months.
@@ -420,6 +419,8 @@ def get_cost_by_org(
         ` ``/historical_cost`` <https://docs.datadoghq.com/api/latest/usage-metering/#get-historical-cost-across-your-account>`_
         instead.
 
+        This endpoint is only accessible for `parent-level organizations <https://docs.datadoghq.com/account_management/multi_organization/>`_.
+
         :param start_month: Datetime in ISO-8601 format, UTC, precise to month: ``[YYYY-MM]`` for cost beginning this month.
         :type start_month: datetime
         :param end_month: Datetime in ISO-8601 format, UTC, precise to month: ``[YYYY-MM]`` for cost ending this month.
@@ -451,6 +452,8 @@ def get_estimated_cost_by_org(
         and is delayed by up to 72 hours from when it was incurred.
         To access historical costs prior to this, use the ``/historical_cost`` endpoint.
 
+        This endpoint is only accessible for `parent-level organizations <https://docs.datadoghq.com/account_management/multi_organization/>`_.
+
         :param view: String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are ``summary`` and ``sub-org``. Defaults to ``summary``.
         :type view: str, optional
         :param start_month: Datetime in ISO-8601 format, UTC, precise to month: ``[YYYY-MM]`` for cost beginning this month. Either start_month or start_date should be specified, but not both. (start_month cannot go beyond two months in the past). Provide an ``end_month`` to view month-over-month cost.
@@ -493,6 +496,8 @@ def get_historical_cost_by_org(
         Get historical cost across multi-org and single root-org accounts.
         Cost data for a given month becomes available no later than the 16th of the following month.
 
+        This endpoint is only accessible for `parent-level organizations <https://docs.datadoghq.com/account_management/multi_organization/>`_.
+
         :param start_month: Datetime in ISO-8601 format, UTC, precise to month: ``[YYYY-MM]`` for cost beginning this month.
         :type start_month: datetime
         :param view: String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are ``summary`` and ``sub-org``.  Defaults to ``summary``.
@@ -610,6 +615,8 @@ def get_monthly_cost_attribution(
              cursor := response.metadata.pagination.next_record_id
            END
 
+        This endpoint is only accessible for `parent-level organizations <https://docs.datadoghq.com/account_management/multi_organization/>`_.
+
         :param start_month: Datetime in ISO-8601 format, UTC, precise to month: ``[YYYY-MM]`` for cost beginning in this month.
         :type start_month: datetime
         :param end_month: Datetime in ISO-8601 format, UTC, precise to month: ``[YYYY-MM]`` for cost ending this month.
@@ -666,7 +673,8 @@ def get_projected_cost(
 
         Get projected cost across multi-org and single root-org accounts.
         Projected cost data is only available for the current month and becomes available around the 12th of the month.
-        This endpoint requires the usage_read authorization scope.
+
+        This endpoint is only accessible for `parent-level organizations <https://docs.datadoghq.com/account_management/multi_organization/>`_.
 
         :param view: String to specify whether cost is broken down at a parent-org level or at the sub-org level. Available views are ``summary`` and ``sub-org``. Defaults to ``summary``.
         :type view: str, optional

tests/v1/features/usage_metering.feature

@@ -2,14 +2,12 @@
 Feature: Usage Metering
   The usage metering API allows you to get hourly, daily, and monthly usage
   across multiple facets of Datadog. This API is available to all Pro and
-  Enterprise customers. Usage is only accessible for [parent-level organizat
-  ions](https://docs.datadoghq.com/account_management/multi_organization/).
-  **Note**: Usage data is delayed by up to 72 hours from when it was
-  incurred. It is retained for 15 months.  You can retrieve up to 24 hours
-  of hourly usage data for multiple organizations, and up to two months of
-  hourly usage data for a single organization in one request. Learn more on
-  the [usage details documentation](https://docs.datadoghq.com/account_manag
-  ement/billing/usage_details/).
+  Enterprise customers.  **Note**: Usage data is delayed by up to 72 hours
+  from when it was incurred. It is retained for 15 months.  You can retrieve
+  up to 24 hours of hourly usage data for multiple organizations, and up to
+  two months of hourly usage data for a single organization in one request.
+  Learn more on the [usage details documentation](https://docs.datadoghq.com
+  /account_management/billing/usage_details/).
 
   Background:
     Given a valid "apiKeyAuth" key in the system

tests/v2/features/usage_metering.feature

@@ -2,14 +2,12 @@
 Feature: Usage Metering
   The usage metering API allows you to get hourly, daily, and monthly usage
   across multiple facets of Datadog. This API is available to all Pro and
-  Enterprise customers. Usage is only accessible for [parent-level organizat
-  ions](https://docs.datadoghq.com/account_management/multi_organization/).
-  **Note**: Usage data is delayed by up to 72 hours from when it was
-  incurred. It is retained for 15 months.  You can retrieve up to 24 hours
-  of hourly usage data for multiple organizations, and up to two months of
-  hourly usage data for a single organization in one request. Learn more on
-  the [usage details documentation](https://docs.datadoghq.com/account_manag
-  ement/billing/usage_details/).
+  Enterprise customers.  **Note**: Usage data is delayed by up to 72 hours
+  from when it was incurred. It is retained for 15 months.  You can retrieve
+  up to 24 hours of hourly usage data for multiple organizations, and up to
+  two months of hourly usage data for a single organization in one request.
+  Learn more on the [usage details documentation](https://docs.datadoghq.com
+  /account_management/billing/usage_details/).
 
   Background:
     Given a valid "apiKeyAuth" key in the system