(DOCS-7109) Add overview details and doc links (#1846)

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>

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-01-22 19:09:10.417108",
-            "spec_repo_commit": "7def3c63"
+            "regenerated": "2024-01-24 20:59:43.240865",
+            "spec_repo_commit": "9d7a3d85"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-01-22 19:09:10.431037",
-            "spec_repo_commit": "7def3c63"
+            "regenerated": "2024-01-24 20:59:43.256115",
+            "spec_repo_commit": "9d7a3d85"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -328,7 +328,7 @@ components:
           type: string
         message:
           description: Message content.
-          example: AWS account 12345 has no lambda config to update
+          example: AWS account 12345 has no Lambda config to update
           type: string
       type: object
     AWSLogsAsyncResponse:
@@ -18067,7 +18067,7 @@ components:
           type: array
       type: object
     UsageLambdaHour:
-      description: 'Number of lambda functions and sum of the invocations of all lambda
+      description: 'Number of Lambda functions and sum of the invocations of all Lambda
         functions
 
         for each hour for a given organization.'
@@ -18095,8 +18095,8 @@ components:
           type: string
       type: object
     UsageLambdaResponse:
-      description: 'Response containing the number of lambda functions and sum of
-        the invocations of all lambda functions
+      description: 'Response containing the number of Lambda functions and sum of
+        the invocations of all Lambda functions
 
         for each hour for a given organization.'
       properties:
@@ -31170,7 +31170,7 @@ paths:
       - Usage Metering
   /api/v1/usage/aws_lambda:
     get:
-      description: 'Get hourly usage for lambda.
+      description: 'Get hourly usage for Lambda.
 
         **Note:** hourly usage data for all products is now available in the [Get
         hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
@@ -31224,7 +31224,7 @@ paths:
         appKeyAuth: []
       - AuthZ:
         - usage_read
-      summary: Get hourly usage for lambda
+      summary: Get hourly usage for Lambda
       tags:
       - Usage Metering
   /api/v1/usage/billable-summary:
@@ -33573,17 +33573,19 @@ tags:
 - description: 'Configure your Datadog-AWS-Logs integration directly through Datadog
     API.
 
-    For more information, see the [AWS integration page](https://docs.datadoghq.com/api/?lang=bash#integration-aws-logs).'
+    For more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection).'
   externalDocs:
-    url: https://docs.datadoghq.com/api/?lang=bash#integration-aws-logs
+    url: https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection
   name: AWS Logs Integration
 - description: "All requests to Datadog\u2019s API must be authenticated.\nRequests
     that write data require reporting access and require an `API key`.\nRequests that
     read data require full access and also require an `application key`.\n\n**Note:**
     All Datadog API clients are configured by default to consume Datadog US site APIs.\nIf
     you are on the Datadog EU site, set the environment variable `DATADOG_HOST` to\n`https://api.datadoghq.eu`
     or override this value directly when creating your client.\n\n[Manage your account\u2019s
-    API and application keys](https://app.datadoghq.com/account/settings#api)."
+    API and application keys](https://app.datadoghq.com/organization-settings/) in
+    Datadog, and see the [API and Application Keys page](https://docs.datadoghq.com/account_management/api-app-keys/)
+    in the documentation."
   name: Authentication
 - description: 'Configure your Datadog-Azure integration directly through the Datadog
     API.
@@ -33826,7 +33828,9 @@ tags:
 
     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.'
+    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/).'
   externalDocs:
     description: Find out more at
     url: https://docs.datadoghq.com/account_management/billing/usage_details/

.generator/schemas/v2/openapi.yaml

@@ -32532,7 +32532,7 @@ paths:
       - Usage Metering
   /api/v2/usage/lambda_traced_invocations:
     get:
-      description: 'Get hourly usage for lambda traced invocations.
+      description: 'Get hourly usage for Lambda traced invocations.
 
         **Note:** hourly usage data for all products is now available in the [Get
         hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family)'
@@ -32586,7 +32586,7 @@ paths:
         appKeyAuth: []
       - AuthZ:
         - usage_read
-      summary: Get hourly usage for lambda traced invocations
+      summary: Get hourly usage for Lambda traced invocations
       tags:
       - Usage Metering
   /api/v2/usage/observability_pipelines:
@@ -33172,32 +33172,39 @@ servers:
 tags:
 - description: Manage configuration of [APM retention filters](https://app.datadoghq.com/apm/traces/retention-filters)
     for your organization. You need an API and application key with Admin rights to
-    interact with this endpoint.
+    interact with this endpoint. See [retention filters](https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/#retention-filters)
+    on the Trace Retention page for more information.
   externalDocs:
     description: Find out more at
     url: https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/
   name: APM Retention Filters
 - description: Search your Audit Logs events over HTTP.
   name: Audit
-- description: '[AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example)
+- description: '[The AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example)
 
-    is used to automatically map group of users to roles in Datadog using attributes
+    is used to automatically map groups of users to roles in Datadog using attributes
 
-    sent from Identity Providers.'
+    sent from Identity Providers. Use these endpoints to manage your AuthN Mappings.'
   name: AuthN Mappings
 - description: Search or aggregate your CI Visibility pipeline events and send them
-    to your Datadog site over HTTP.
+    to your Datadog site over HTTP. See the [CI Pipeline Visibility in Datadog page](https://docs.datadoghq.com/continuous_integration/pipelines/)
+    for more information.
   name: CI Visibility Pipelines
-- description: Search or aggregate your CI Visibility test events over HTTP.
+- description: Search or aggregate your CI Visibility test events over HTTP. See the
+    [Test Visibility in Datadog page](https://docs.datadoghq.com/tests/) for more
+    information.
   name: CI Visibility Tests
-- description: The Cloud Cost Management API allows you to setup, edit and delete
-    cloud cost management accounts for AWS & Azure.
+- description: The Cloud Cost Management API allows you to set up, edit, and delete
+    Cloud Cost Management accounts for AWS and Azure. See the [Cloud Cost Management
+    page](https://docs.datadoghq.com/cloud_cost_management/) for more information.
   name: Cloud Cost Management
 - description: Workload activity security rules for generating events using the Datadog
-    security Agent.
+    security Agent. See the [Setting up CSM Workload Security page](https://docs.datadoghq.com/security/cloud_security_management/setup/csm_workload_security/)
+    for more information.
   name: Cloud Workload Security
-- description: Configure your Datadog Cloudflare integration directly through the
-    Datadog API.
+- description: Manage your Datadog Cloudflare integration directly through the Datadog
+    API. See the [Cloudflare integration page](https://docs.datadoghq.com/integrations/cloudflare/)
+    for more information.
   name: Cloudflare Integration
 - description: Configure your Datadog Confluent Cloud integration directly through
     the Datadog API.
@@ -33208,6 +33215,8 @@ tags:
 - description: The Containers API allows you to query container data for your organization.
   name: Containers
 - description: Send events for DORA Metrics to measure and improve software delivery.
+    See the [DORA Metrics page](https://docs.datadoghq.com/dora_metrics/) for more
+    information.
   name: DORA Metrics
 - description: 'Interact with your dashboard lists through the API to
 
@@ -33429,7 +33438,9 @@ tags:
 
     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.'
+    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/).'
   externalDocs:
     description: Find out more at
     url: https://docs.datadoghq.com/account_management/billing/usage_details/

examples/v1/usage-metering/GetUsageLambda.py

@@ -1,17 +1,18 @@
 """
-Get hourly usage for lambda returns "OK" response
+Get hourly usage for Lambda returns "OK" response
 """
 
+from datetime import datetime
+from dateutil.relativedelta import relativedelta
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v1.api.usage_metering_api import UsageMeteringApi
-from datetime import datetime
-from dateutil.tz import tzutc
 
 configuration = Configuration()
 with ApiClient(configuration) as api_client:
     api_instance = UsageMeteringApi(api_client)
     response = api_instance.get_usage_lambda(
-        start_hr=datetime(2021, 11, 11, 11, 11, 11, 111000, tzinfo=tzutc()),
+        start_hr=(datetime.now() + relativedelta(days=-5)),
+        end_hr=(datetime.now() + relativedelta(days=-3)),
     )
 
     print(response)

examples/v2/usage-metering/GetUsageLambdaTracedInvocations.py

@@ -1,5 +1,5 @@
 """
-Get hourly usage for lambda traced invocations returns "OK" response
+Get hourly usage for Lambda traced invocations returns "OK" response
 """
 
 from datetime import datetime

src/datadog_api_client/v1/api/authentication_api.py

@@ -20,7 +20,7 @@ class AuthenticationApi:
     If you are on the Datadog EU site, set the environment variable ``DATADOG_HOST`` to
     ``https://api.datadoghq.eu`` or override this value directly when creating your client.
 
-    `Manage your account’s API and application keys <https://app.datadoghq.com/account/settings#api>`_.
+    `Manage your account’s API and application keys <https://app.datadoghq.com/organization-settings/>`_ in Datadog, and see the `API and Application Keys page <https://docs.datadoghq.com/account_management/api-app-keys/>`_ in the documentation.
     """
 
     def __init__(self, api_client=None):

src/datadog_api_client/v1/api/aws_logs_integration_api.py

@@ -17,7 +17,7 @@
 class AWSLogsIntegrationApi:
     """
     Configure your Datadog-AWS-Logs integration directly through Datadog API.
-    For more information, see the `AWS integration page <https://docs.datadoghq.com/api/?lang=bash#integration-aws-logs>`_.
+    For more information, see the `AWS integration page <https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection>`_.
     """
 
     def __init__(self, api_client=None):

src/datadog_api_client/v1/api/usage_metering_api.py

@@ -73,6 +73,7 @@ class UsageMeteringApi:
 
     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/>`_.
     """
 
     def __init__(self, api_client=None):
@@ -1922,9 +1923,9 @@ def get_usage_lambda(
         *,
         end_hr: Union[datetime, UnsetType] = unset,
     ) -> UsageLambdaResponse:
-        """Get hourly usage for lambda.
+        """Get hourly usage for Lambda.
 
-        Get hourly usage for lambda.
+        Get hourly usage for Lambda.
         **Note:** hourly usage data for all products is now available in the `Get hourly usage by product family API <https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family>`_. Refer to `Migrating from the V1 Hourly Usage APIs to V2 <https://docs.datadoghq.com/account_management/guide/hourly-usage-migration/>`_ for the associated migration guide.
 
         :param start_hr: Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour.

src/datadog_api_client/v1/model/usage_lambda_hour.py

@@ -44,7 +44,7 @@ def __init__(
         **kwargs,
     ):
         """
-        Number of lambda functions and sum of the invocations of all lambda functions
+        Number of Lambda functions and sum of the invocations of all Lambda functions
         for each hour for a given organization.
 
         :param func_count: Contains the number of different functions for each region and AWS account.

src/datadog_api_client/v1/model/usage_lambda_response.py

@@ -32,7 +32,7 @@ def openapi_types(_):
 
     def __init__(self_, usage: Union[List[UsageLambdaHour], UnsetType] = unset, **kwargs):
         """
-        Response containing the number of lambda functions and sum of the invocations of all lambda functions
+        Response containing the number of Lambda functions and sum of the invocations of all Lambda functions
         for each hour for a given organization.
 
         :param usage: Get hourly usage for Lambda.

src/datadog_api_client/v2/api/apm_retention_filters_api.py

@@ -16,7 +16,7 @@
 
 class APMRetentionFiltersApi:
     """
-    Manage configuration of `APM retention filters <https://app.datadoghq.com/apm/traces/retention-filters>`_ for your organization. You need an API and application key with Admin rights to interact with this endpoint.
+    Manage configuration of `APM retention filters <https://app.datadoghq.com/apm/traces/retention-filters>`_ for your organization. You need an API and application key with Admin rights to interact with this endpoint. See `retention filters <https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/#retention-filters>`_ on the Trace Retention page for more information.
     """
 
     def __init__(self, api_client=None):

src/datadog_api_client/v2/api/authn_mappings_api.py

@@ -20,9 +20,9 @@
 
 class AuthNMappingsApi:
     """
-    `AuthN Mappings API <https://docs.datadoghq.com/account_management/authn_mapping/?tab=example>`_
-    is used to automatically map group of users to roles in Datadog using attributes
-    sent from Identity Providers.
+    `The AuthN Mappings API <https://docs.datadoghq.com/account_management/authn_mapping/?tab=example>`_
+    is used to automatically map groups of users to roles in Datadog using attributes
+    sent from Identity Providers. Use these endpoints to manage your AuthN Mappings.
     """
 
     def __init__(self, api_client=None):

src/datadog_api_client/v2/api/ci_visibility_pipelines_api.py

@@ -28,7 +28,7 @@
 
 class CIVisibilityPipelinesApi:
     """
-    Search or aggregate your CI Visibility pipeline events and send them to your Datadog site over HTTP.
+    Search or aggregate your CI Visibility pipeline events and send them to your Datadog site over HTTP. See the `CI Pipeline Visibility in Datadog page <https://docs.datadoghq.com/continuous_integration/pipelines/>`_ for more information.
     """
 
     def __init__(self, api_client=None):

src/datadog_api_client/v2/api/ci_visibility_tests_api.py

@@ -25,7 +25,7 @@
 
 class CIVisibilityTestsApi:
     """
-    Search or aggregate your CI Visibility test events over HTTP.
+    Search or aggregate your CI Visibility test events over HTTP. See the `Test Visibility in Datadog page <https://docs.datadoghq.com/tests/>`_ for more information.
     """
 
     def __init__(self, api_client=None):

src/datadog_api_client/v2/api/cloud_cost_management_api.py

@@ -21,7 +21,7 @@
 
 class CloudCostManagementApi:
     """
-    The Cloud Cost Management API allows you to setup, edit and delete cloud cost management accounts for AWS & Azure.
+    The Cloud Cost Management API allows you to set up, edit, and delete Cloud Cost Management accounts for AWS and Azure. See the `Cloud Cost Management page <https://docs.datadoghq.com/cloud_cost_management/>`_ for more information.
     """
 
     def __init__(self, api_client=None):

src/datadog_api_client/v2/api/cloud_workload_security_api.py

@@ -26,7 +26,7 @@
 
 class CloudWorkloadSecurityApi:
     """
-    Workload activity security rules for generating events using the Datadog security Agent.
+    Workload activity security rules for generating events using the Datadog security Agent. See the `Setting up CSM Workload Security page <https://docs.datadoghq.com/security/cloud_security_management/setup/csm_workload_security/>`_ for more information.
     """
 
     def __init__(self, api_client=None):

src/datadog_api_client/v2/api/cloudflare_integration_api.py

@@ -15,7 +15,7 @@
 
 class CloudflareIntegrationApi:
     """
-    Configure your Datadog Cloudflare integration directly through the Datadog API.
+    Manage your Datadog Cloudflare integration directly through the Datadog API. See the `Cloudflare integration page <https://docs.datadoghq.com/integrations/cloudflare/>`_ for more information.
     """
 
     def __init__(self, api_client=None):

src/datadog_api_client/v2/api/dora_metrics_api.py

@@ -15,7 +15,7 @@
 
 class DORAMetricsApi:
     """
-    Send events for DORA Metrics to measure and improve software delivery.
+    Send events for DORA Metrics to measure and improve software delivery. See the `DORA Metrics page <https://docs.datadoghq.com/dora_metrics/>`_ for more information.
     """
 
     def __init__(self, api_client=None):

src/datadog_api_client/v2/api/usage_metering_api.py

@@ -38,6 +38,7 @@ class UsageMeteringApi:
 
     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/>`_.
     """
 
     def __init__(self, api_client=None):
@@ -709,9 +710,9 @@ def get_usage_lambda_traced_invocations(
         *,
         end_hr: Union[datetime, UnsetType] = unset,
     ) -> UsageLambdaTracedInvocationsResponse:
-        """Get hourly usage for lambda traced invocations.
+        """Get hourly usage for Lambda traced invocations.
 
-        Get hourly usage for lambda traced invocations.
+        Get hourly usage for Lambda traced invocations.
         **Note:** hourly usage data for all products is now available in the `Get hourly usage by product family API <https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family>`_
 
         :param start_hr: Datetime in ISO-8601 format, UTC, precise to hour: ``[YYYY-MM-DDThh]`` for usage beginning at this hour.