From 516e24a75400b4e9a4dfe8358fc65afcefa4aee6 Mon Sep 17 00:00:00 2001 From: "api-clients-generation-pipeline[bot]" <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> Date: Thu, 25 Jan 2024 15:50:17 +0000 Subject: [PATCH] (DOCS-7109) Add overview details and doc links (#1846) Co-authored-by: ci.datadog-api-spec Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> --- .apigentools-info | 8 ++-- .generator/schemas/v1/openapi.yaml | 24 +++++++----- .generator/schemas/v2/openapi.yaml | 39 ++++++++++++------- examples/v1/usage-metering/GetUsageLambda.py | 9 +++-- .../GetUsageLambda_3132428705.py | 18 --------- .../GetUsageLambdaTracedInvocations.py | 2 +- .../v1/api/authentication_api.py | 2 +- .../v1/api/aws_logs_integration_api.py | 2 +- .../v1/api/usage_metering_api.py | 5 ++- .../v1/model/usage_lambda_hour.py | 2 +- .../v1/model/usage_lambda_response.py | 2 +- .../v2/api/apm_retention_filters_api.py | 2 +- .../v2/api/authn_mappings_api.py | 6 +-- .../v2/api/ci_visibility_pipelines_api.py | 2 +- .../v2/api/ci_visibility_tests_api.py | 2 +- .../v2/api/cloud_cost_management_api.py | 2 +- .../v2/api/cloud_workload_security_api.py | 2 +- .../v2/api/cloudflare_integration_api.py | 2 +- .../v2/api/dora_metrics_api.py | 2 +- .../v2/api/usage_metering_api.py | 5 ++- tests/v1/features/authentication.feature | 5 ++- .../v1/features/aws_logs_integration.feature | 3 +- tests/v1/features/usage_metering.feature | 18 ++------- ...ations_returns_bad_request_response.frozen | 2 +- ...ocations_returns_bad_request_response.yaml | 6 +-- ...ced_invocations_returns_ok_response.frozen | 2 +- ...raced_invocations_returns_ok_response.yaml | 6 +-- .../v2/features/apm_retention_filters.feature | 4 +- tests/v2/features/authn_mappings.feature | 7 ++-- .../features/ci_visibility_pipelines.feature | 4 +- tests/v2/features/ci_visibility_tests.feature | 4 +- .../v2/features/cloud_cost_management.feature | 6 ++- .../features/cloud_workload_security.feature | 4 +- .../features/cloudflare_integration.feature | 6 ++- tests/v2/features/dora_metrics.feature | 4 +- tests/v2/features/usage_metering.feature | 33 +++++++--------- 36 files changed, 126 insertions(+), 126 deletions(-) delete mode 100644 examples/v1/usage-metering/GetUsageLambda_3132428705.py diff --git a/.apigentools-info b/.apigentools-info index 59f1b3df1b..9da58c0b9f 100644 --- a/.apigentools-info +++ b/.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" } } } \ No newline at end of file diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml index edeba8d4bb..533665874c 100644 --- a/.generator/schemas/v1/openapi.yaml +++ b/.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,9 +33573,9 @@ 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 @@ -33583,7 +33583,9 @@ tags: 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/ diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 53b6ef61a9..fabb982d2a 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.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/ diff --git a/examples/v1/usage-metering/GetUsageLambda.py b/examples/v1/usage-metering/GetUsageLambda.py index e508fc6f26..8e480947a6 100644 --- a/examples/v1/usage-metering/GetUsageLambda.py +++ b/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) diff --git a/examples/v1/usage-metering/GetUsageLambda_3132428705.py b/examples/v1/usage-metering/GetUsageLambda_3132428705.py deleted file mode 100644 index 8e480947a6..0000000000 --- a/examples/v1/usage-metering/GetUsageLambda_3132428705.py +++ /dev/null @@ -1,18 +0,0 @@ -""" -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 - -configuration = Configuration() -with ApiClient(configuration) as api_client: - api_instance = UsageMeteringApi(api_client) - response = api_instance.get_usage_lambda( - start_hr=(datetime.now() + relativedelta(days=-5)), - end_hr=(datetime.now() + relativedelta(days=-3)), - ) - - print(response) diff --git a/examples/v2/usage-metering/GetUsageLambdaTracedInvocations.py b/examples/v2/usage-metering/GetUsageLambdaTracedInvocations.py index ad1990e002..7c04f3065e 100644 --- a/examples/v2/usage-metering/GetUsageLambdaTracedInvocations.py +++ b/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 diff --git a/src/datadog_api_client/v1/api/authentication_api.py b/src/datadog_api_client/v1/api/authentication_api.py index e152a3f767..c39e295122 100644 --- a/src/datadog_api_client/v1/api/authentication_api.py +++ b/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 `_. + `Manage your account’s API and application keys `_ in Datadog, and see the `API and Application Keys page `_ in the documentation. """ def __init__(self, api_client=None): diff --git a/src/datadog_api_client/v1/api/aws_logs_integration_api.py b/src/datadog_api_client/v1/api/aws_logs_integration_api.py index 539ec2d400..fd88dec1a9 100644 --- a/src/datadog_api_client/v1/api/aws_logs_integration_api.py +++ b/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 `_. + For more information, see the `AWS integration page `_. """ def __init__(self, api_client=None): diff --git a/src/datadog_api_client/v1/api/usage_metering_api.py b/src/datadog_api_client/v1/api/usage_metering_api.py index 0951a8fd4b..4cbe415c8e 100644 --- a/src/datadog_api_client/v1/api/usage_metering_api.py +++ b/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 `_. """ 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 `_. Refer to `Migrating from the V1 Hourly Usage APIs to V2 `_ 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. diff --git a/src/datadog_api_client/v1/model/usage_lambda_hour.py b/src/datadog_api_client/v1/model/usage_lambda_hour.py index d1bda524bf..fd8adcecca 100644 --- a/src/datadog_api_client/v1/model/usage_lambda_hour.py +++ b/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. diff --git a/src/datadog_api_client/v1/model/usage_lambda_response.py b/src/datadog_api_client/v1/model/usage_lambda_response.py index 26f9352bcf..0ec9562f7d 100644 --- a/src/datadog_api_client/v1/model/usage_lambda_response.py +++ b/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. diff --git a/src/datadog_api_client/v2/api/apm_retention_filters_api.py b/src/datadog_api_client/v2/api/apm_retention_filters_api.py index 8422d688f2..730346d1c6 100644 --- a/src/datadog_api_client/v2/api/apm_retention_filters_api.py +++ b/src/datadog_api_client/v2/api/apm_retention_filters_api.py @@ -16,7 +16,7 @@ class APMRetentionFiltersApi: """ - Manage configuration of `APM 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 `_ for your organization. You need an API and application key with Admin rights to interact with this endpoint. See `retention filters `_ on the Trace Retention page for more information. """ def __init__(self, api_client=None): diff --git a/src/datadog_api_client/v2/api/authn_mappings_api.py b/src/datadog_api_client/v2/api/authn_mappings_api.py index 02d407f398..0e58524d8b 100644 --- a/src/datadog_api_client/v2/api/authn_mappings_api.py +++ b/src/datadog_api_client/v2/api/authn_mappings_api.py @@ -20,9 +20,9 @@ class AuthNMappingsApi: """ - `AuthN Mappings API `_ - is used to automatically map group of users to roles in Datadog using attributes - sent from Identity Providers. + `The AuthN Mappings API `_ + 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): diff --git a/src/datadog_api_client/v2/api/ci_visibility_pipelines_api.py b/src/datadog_api_client/v2/api/ci_visibility_pipelines_api.py index 6c98f69dc5..60bc5ee1ad 100644 --- a/src/datadog_api_client/v2/api/ci_visibility_pipelines_api.py +++ b/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 `_ for more information. """ def __init__(self, api_client=None): diff --git a/src/datadog_api_client/v2/api/ci_visibility_tests_api.py b/src/datadog_api_client/v2/api/ci_visibility_tests_api.py index 3a84481640..68df131dff 100644 --- a/src/datadog_api_client/v2/api/ci_visibility_tests_api.py +++ b/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 `_ for more information. """ def __init__(self, api_client=None): diff --git a/src/datadog_api_client/v2/api/cloud_cost_management_api.py b/src/datadog_api_client/v2/api/cloud_cost_management_api.py index 2a7565743a..ef1c59bd10 100644 --- a/src/datadog_api_client/v2/api/cloud_cost_management_api.py +++ b/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 `_ for more information. """ def __init__(self, api_client=None): diff --git a/src/datadog_api_client/v2/api/cloud_workload_security_api.py b/src/datadog_api_client/v2/api/cloud_workload_security_api.py index c4da974572..28ec794c50 100644 --- a/src/datadog_api_client/v2/api/cloud_workload_security_api.py +++ b/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 `_ for more information. """ def __init__(self, api_client=None): diff --git a/src/datadog_api_client/v2/api/cloudflare_integration_api.py b/src/datadog_api_client/v2/api/cloudflare_integration_api.py index f0951f9f63..ef84eec959 100644 --- a/src/datadog_api_client/v2/api/cloudflare_integration_api.py +++ b/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 `_ for more information. """ def __init__(self, api_client=None): diff --git a/src/datadog_api_client/v2/api/dora_metrics_api.py b/src/datadog_api_client/v2/api/dora_metrics_api.py index 69ce587202..26536f316f 100644 --- a/src/datadog_api_client/v2/api/dora_metrics_api.py +++ b/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 `_ for more information. """ def __init__(self, api_client=None): diff --git a/src/datadog_api_client/v2/api/usage_metering_api.py b/src/datadog_api_client/v2/api/usage_metering_api.py index 08628b55ac..81b5926f73 100644 --- a/src/datadog_api_client/v2/api/usage_metering_api.py +++ b/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 `_. """ 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 `_ :param start_hr: Datetime in ISO-8601 format, UTC, precise to hour: ``[YYYY-MM-DDThh]`` for usage beginning at this hour. diff --git a/tests/v1/features/authentication.feature b/tests/v1/features/authentication.feature index 9166a91261..b82a231321 100644 --- a/tests/v1/features/authentication.feature +++ b/tests/v1/features/authentication.feature @@ -7,7 +7,10 @@ Feature: Authentication site APIs. 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). + 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. Background: Given an instance of "Authentication" API diff --git a/tests/v1/features/aws_logs_integration.feature b/tests/v1/features/aws_logs_integration.feature index 2dfda844ec..5459cbb794 100644 --- a/tests/v1/features/aws_logs_integration.feature +++ b/tests/v1/features/aws_logs_integration.feature @@ -2,7 +2,8 @@ Feature: AWS Logs Integration 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). + page](https://docs.datadoghq.com/integrations/amazon_web_services/#log- + collection). Background: Given a valid "apiKeyAuth" key in the system diff --git a/tests/v1/features/usage_metering.feature b/tests/v1/features/usage_metering.feature index 5cec7da17a..391d674cb0 100644 --- a/tests/v1/features/usage_metering.feature +++ b/tests/v1/features/usage_metering.feature @@ -7,7 +7,9 @@ Feature: Usage Metering **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. + 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/). Background: Given a valid "apiKeyAuth" key in the system @@ -485,20 +487,6 @@ Feature: Usage Metering When the request is sent Then the response status is 200 OK - @generated @skip @team:DataDog/red-zone-revenue-query - Scenario: Get hourly usage for lambda returns "Bad Request" response - Given new "GetUsageLambda" request - And request contains "start_hr" parameter from "REPLACE.ME" - When the request is sent - Then the response status is 400 Bad Request - - @generated @skip @team:DataDog/red-zone-revenue-query - Scenario: Get hourly usage for lambda returns "OK" response - Given new "GetUsageLambda" request - And request contains "start_hr" parameter from "REPLACE.ME" - When the request is sent - Then the response status is 200 OK - @generated @skip @team:DataDog/red-zone-revenue-query Scenario: Get hourly usage for logs by index returns "Bad Request" response Given new "GetUsageLogsByIndex" request diff --git a/tests/v2/cassettes/test_scenarios/test_get_hourly_usage_for_lambda_traced_invocations_returns_bad_request_response.frozen b/tests/v2/cassettes/test_scenarios/test_get_hourly_usage_for_lambda_traced_invocations_returns_bad_request_response.frozen index 229352402a..79cf778bd3 100644 --- a/tests/v2/cassettes/test_scenarios/test_get_hourly_usage_for_lambda_traced_invocations_returns_bad_request_response.frozen +++ b/tests/v2/cassettes/test_scenarios/test_get_hourly_usage_for_lambda_traced_invocations_returns_bad_request_response.frozen @@ -1 +1 @@ -2022-05-06T18:07:36.174Z \ No newline at end of file +2024-01-24T20:56:23.911Z \ No newline at end of file diff --git a/tests/v2/cassettes/test_scenarios/test_get_hourly_usage_for_lambda_traced_invocations_returns_bad_request_response.yaml b/tests/v2/cassettes/test_scenarios/test_get_hourly_usage_for_lambda_traced_invocations_returns_bad_request_response.yaml index b8609602ba..837caf0d17 100644 --- a/tests/v2/cassettes/test_scenarios/test_get_hourly_usage_for_lambda_traced_invocations_returns_bad_request_response.yaml +++ b/tests/v2/cassettes/test_scenarios/test_get_hourly_usage_for_lambda_traced_invocations_returns_bad_request_response.yaml @@ -5,12 +5,10 @@ interactions: accept: - application/json;datetime-format=rfc3339 method: GET - uri: https://api.datadoghq.com/api/v2/usage/lambda_traced_invocations?start_hr=2022-05-03T18%3A07%3A36.174Z&end_hr=2022-05-01T18%3A07%3A36.174Z + uri: https://api.datadoghq.com/api/v2/usage/lambda_traced_invocations?start_hr=2024-01-21T20%3A56%3A23.911Z&end_hr=2024-01-19T20%3A56%3A23.911Z response: body: - string: '{"errors":["start_hr [YYYY-MM-DDThh] must be before end_hr [YYYY-MM-DDThh]"]} - - ' + string: '{"errors":["start_hr [YYYY-MM-DDThh] must be before end_hr [YYYY-MM-DDThh]"]}' headers: content-type: - application/json diff --git a/tests/v2/cassettes/test_scenarios/test_get_hourly_usage_for_lambda_traced_invocations_returns_ok_response.frozen b/tests/v2/cassettes/test_scenarios/test_get_hourly_usage_for_lambda_traced_invocations_returns_ok_response.frozen index 3513390306..059c2884ec 100644 --- a/tests/v2/cassettes/test_scenarios/test_get_hourly_usage_for_lambda_traced_invocations_returns_ok_response.frozen +++ b/tests/v2/cassettes/test_scenarios/test_get_hourly_usage_for_lambda_traced_invocations_returns_ok_response.frozen @@ -1 +1 @@ -2023-10-16T15:12:09.282Z \ No newline at end of file +2024-01-24T20:54:39.781Z \ No newline at end of file diff --git a/tests/v2/cassettes/test_scenarios/test_get_hourly_usage_for_lambda_traced_invocations_returns_ok_response.yaml b/tests/v2/cassettes/test_scenarios/test_get_hourly_usage_for_lambda_traced_invocations_returns_ok_response.yaml index 159f6bb134..fbe86d3c38 100644 --- a/tests/v2/cassettes/test_scenarios/test_get_hourly_usage_for_lambda_traced_invocations_returns_ok_response.yaml +++ b/tests/v2/cassettes/test_scenarios/test_get_hourly_usage_for_lambda_traced_invocations_returns_ok_response.yaml @@ -5,11 +5,11 @@ interactions: accept: - application/json;datetime-format=rfc3339 method: GET - uri: https://api.datadoghq.com/api/v2/usage/lambda_traced_invocations?start_hr=2023-10-11T15%3A12%3A09.282Z&end_hr=2023-10-13T15%3A12%3A09.282Z + uri: https://api.datadoghq.com/api/v2/usage/lambda_traced_invocations?start_hr=2024-01-19T20%3A54%3A39.781Z&end_hr=2024-01-21T20%3A54%3A39.781Z response: body: - string: '{"data":[{"id":"355647a75c3260178b469bb5f0d27751bcdf74c97170e13d55553bee12f9462f","type":"usage_timeseries","attributes":{"product_family":"lambda-traced-invocations","usage_type":"lambda_traced_invocations_count","org_name":"DD - Integration Tests (321813)","public_id":"fasjyydbcgwwc2uc","region":"us","timeseries":[{"timestamp":"2023-10-11T15:00:00+00:00","value":null},{"timestamp":"2023-10-11T16:00:00+00:00","value":null},{"timestamp":"2023-10-11T17:00:00+00:00","value":null},{"timestamp":"2023-10-11T18:00:00+00:00","value":null},{"timestamp":"2023-10-11T19:00:00+00:00","value":null},{"timestamp":"2023-10-11T20:00:00+00:00","value":null},{"timestamp":"2023-10-11T21:00:00+00:00","value":null},{"timestamp":"2023-10-11T22:00:00+00:00","value":null},{"timestamp":"2023-10-11T23:00:00+00:00","value":null},{"timestamp":"2023-10-12T00:00:00+00:00","value":null},{"timestamp":"2023-10-12T01:00:00+00:00","value":null},{"timestamp":"2023-10-12T02:00:00+00:00","value":null},{"timestamp":"2023-10-12T03:00:00+00:00","value":null},{"timestamp":"2023-10-12T04:00:00+00:00","value":null},{"timestamp":"2023-10-12T05:00:00+00:00","value":null},{"timestamp":"2023-10-12T06:00:00+00:00","value":null},{"timestamp":"2023-10-12T07:00:00+00:00","value":null},{"timestamp":"2023-10-12T08:00:00+00:00","value":null},{"timestamp":"2023-10-12T09:00:00+00:00","value":null},{"timestamp":"2023-10-12T10:00:00+00:00","value":null},{"timestamp":"2023-10-12T11:00:00+00:00","value":null},{"timestamp":"2023-10-12T12:00:00+00:00","value":null},{"timestamp":"2023-10-12T13:00:00+00:00","value":null},{"timestamp":"2023-10-12T14:00:00+00:00","value":null},{"timestamp":"2023-10-12T15:00:00+00:00","value":null},{"timestamp":"2023-10-12T16:00:00+00:00","value":null},{"timestamp":"2023-10-12T17:00:00+00:00","value":null},{"timestamp":"2023-10-12T18:00:00+00:00","value":null},{"timestamp":"2023-10-12T19:00:00+00:00","value":null},{"timestamp":"2023-10-12T20:00:00+00:00","value":null},{"timestamp":"2023-10-12T21:00:00+00:00","value":null},{"timestamp":"2023-10-12T22:00:00+00:00","value":null},{"timestamp":"2023-10-12T23:00:00+00:00","value":null},{"timestamp":"2023-10-13T00:00:00+00:00","value":null},{"timestamp":"2023-10-13T01:00:00+00:00","value":null},{"timestamp":"2023-10-13T02:00:00+00:00","value":null},{"timestamp":"2023-10-13T03:00:00+00:00","value":null},{"timestamp":"2023-10-13T04:00:00+00:00","value":null},{"timestamp":"2023-10-13T05:00:00+00:00","value":null},{"timestamp":"2023-10-13T06:00:00+00:00","value":null},{"timestamp":"2023-10-13T07:00:00+00:00","value":null},{"timestamp":"2023-10-13T08:00:00+00:00","value":null},{"timestamp":"2023-10-13T09:00:00+00:00","value":null},{"timestamp":"2023-10-13T10:00:00+00:00","value":null},{"timestamp":"2023-10-13T11:00:00+00:00","value":null},{"timestamp":"2023-10-13T12:00:00+00:00","value":null},{"timestamp":"2023-10-13T13:00:00+00:00","value":null},{"timestamp":"2023-10-13T14:00:00+00:00","value":null}]}}]} + string: '{"data":[{"id":"41945ceef2349387d82c498d0d83cb88b2c57e90d273d9cfa0826d3cac2ecc45","type":"usage_timeseries","attributes":{"product_family":"lambda-traced-invocations","usage_type":"lambda_traced_invocations_count","org_name":"DD + Integration Tests (321813)","public_id":"fasjyydbcgwwc2uc","region":"us","timeseries":[{"timestamp":"2024-01-19T20:00:00+00:00","value":null},{"timestamp":"2024-01-19T21:00:00+00:00","value":null},{"timestamp":"2024-01-19T22:00:00+00:00","value":null},{"timestamp":"2024-01-19T23:00:00+00:00","value":null},{"timestamp":"2024-01-20T00:00:00+00:00","value":null},{"timestamp":"2024-01-20T01:00:00+00:00","value":null},{"timestamp":"2024-01-20T02:00:00+00:00","value":null},{"timestamp":"2024-01-20T03:00:00+00:00","value":null},{"timestamp":"2024-01-20T04:00:00+00:00","value":null},{"timestamp":"2024-01-20T05:00:00+00:00","value":null},{"timestamp":"2024-01-20T06:00:00+00:00","value":null},{"timestamp":"2024-01-20T07:00:00+00:00","value":null},{"timestamp":"2024-01-20T08:00:00+00:00","value":null},{"timestamp":"2024-01-20T09:00:00+00:00","value":null},{"timestamp":"2024-01-20T10:00:00+00:00","value":null},{"timestamp":"2024-01-20T11:00:00+00:00","value":null},{"timestamp":"2024-01-20T12:00:00+00:00","value":null},{"timestamp":"2024-01-20T13:00:00+00:00","value":null},{"timestamp":"2024-01-20T14:00:00+00:00","value":null},{"timestamp":"2024-01-20T15:00:00+00:00","value":null},{"timestamp":"2024-01-20T16:00:00+00:00","value":null},{"timestamp":"2024-01-20T17:00:00+00:00","value":null},{"timestamp":"2024-01-20T18:00:00+00:00","value":null},{"timestamp":"2024-01-20T19:00:00+00:00","value":null},{"timestamp":"2024-01-20T20:00:00+00:00","value":null},{"timestamp":"2024-01-20T21:00:00+00:00","value":null},{"timestamp":"2024-01-20T22:00:00+00:00","value":null},{"timestamp":"2024-01-20T23:00:00+00:00","value":null},{"timestamp":"2024-01-21T00:00:00+00:00","value":null},{"timestamp":"2024-01-21T01:00:00+00:00","value":null},{"timestamp":"2024-01-21T02:00:00+00:00","value":null},{"timestamp":"2024-01-21T03:00:00+00:00","value":null},{"timestamp":"2024-01-21T04:00:00+00:00","value":null},{"timestamp":"2024-01-21T05:00:00+00:00","value":null},{"timestamp":"2024-01-21T06:00:00+00:00","value":null},{"timestamp":"2024-01-21T07:00:00+00:00","value":null},{"timestamp":"2024-01-21T08:00:00+00:00","value":null},{"timestamp":"2024-01-21T09:00:00+00:00","value":null},{"timestamp":"2024-01-21T10:00:00+00:00","value":null},{"timestamp":"2024-01-21T11:00:00+00:00","value":null},{"timestamp":"2024-01-21T12:00:00+00:00","value":null},{"timestamp":"2024-01-21T13:00:00+00:00","value":null},{"timestamp":"2024-01-21T14:00:00+00:00","value":null},{"timestamp":"2024-01-21T15:00:00+00:00","value":null},{"timestamp":"2024-01-21T16:00:00+00:00","value":null},{"timestamp":"2024-01-21T17:00:00+00:00","value":null},{"timestamp":"2024-01-21T18:00:00+00:00","value":null},{"timestamp":"2024-01-21T19:00:00+00:00","value":null}]}}]} ' headers: diff --git a/tests/v2/features/apm_retention_filters.feature b/tests/v2/features/apm_retention_filters.feature index 7b80ee68b6..e88870c76d 100644 --- a/tests/v2/features/apm_retention_filters.feature +++ b/tests/v2/features/apm_retention_filters.feature @@ -3,7 +3,9 @@ Feature: APM Retention Filters 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.datadogh + q.com/tracing/trace_pipeline/trace_retention/#retention-filters) on the + Trace Retention page for more information. Background: Given a valid "apiKeyAuth" key in the system diff --git a/tests/v2/features/authn_mappings.feature b/tests/v2/features/authn_mappings.feature index 7fab254f7a..a90c3e6ade 100644 --- a/tests/v2/features/authn_mappings.feature +++ b/tests/v2/features/authn_mappings.feature @@ -1,8 +1,9 @@ @endpoint(authn-mappings) @endpoint(authn-mappings-v2) Feature: AuthN Mappings - [AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_m - apping/?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/aut + hn_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. Background: Given a valid "apiKeyAuth" key in the system diff --git a/tests/v2/features/ci_visibility_pipelines.feature b/tests/v2/features/ci_visibility_pipelines.feature index 6134cb06a5..40d1b25b71 100644 --- a/tests/v2/features/ci_visibility_pipelines.feature +++ b/tests/v2/features/ci_visibility_pipelines.feature @@ -1,7 +1,9 @@ @endpoint(ci-visibility-pipelines) @endpoint(ci-visibility-pipelines-v2) Feature: CI Visibility Pipelines Search or aggregate your CI Visibility pipeline events and send them to - your Datadog site over HTTP. + your Datadog site over HTTP. See the [CI Pipeline Visibility in Datadog + page](https://docs.datadoghq.com/continuous_integration/pipelines/) for + more information. Background: Given a valid "apiKeyAuth" key in the system diff --git a/tests/v2/features/ci_visibility_tests.feature b/tests/v2/features/ci_visibility_tests.feature index 3152496cf7..64bc72fbf9 100644 --- a/tests/v2/features/ci_visibility_tests.feature +++ b/tests/v2/features/ci_visibility_tests.feature @@ -1,6 +1,8 @@ @endpoint(ci-visibility-tests) @endpoint(ci-visibility-tests-v2) Feature: CI Visibility Tests - 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. Background: Given a valid "apiKeyAuth" key in the system diff --git a/tests/v2/features/cloud_cost_management.feature b/tests/v2/features/cloud_cost_management.feature index 1dfb05baea..e87b6dc471 100644 --- a/tests/v2/features/cloud_cost_management.feature +++ b/tests/v2/features/cloud_cost_management.feature @@ -1,7 +1,9 @@ @endpoint(cloud-cost-management) @endpoint(cloud-cost-management-v2) Feature: Cloud Cost Management - 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. Background: Given a valid "apiKeyAuth" key in the system diff --git a/tests/v2/features/cloud_workload_security.feature b/tests/v2/features/cloud_workload_security.feature index ca0850217f..ae068c81dc 100644 --- a/tests/v2/features/cloud_workload_security.feature +++ b/tests/v2/features/cloud_workload_security.feature @@ -1,7 +1,9 @@ @endpoint(cloud-workload-security) @endpoint(cloud-workload-security-v2) Feature: Cloud Workload Security Workload activity security rules for generating events using the Datadog - security Agent. + security Agent. See the [Setting up CSM Workload Security page](https://do + cs.datadoghq.com/security/cloud_security_management/setup/csm_workload_sec + urity/) for more information. Background: Given a valid "apiKeyAuth" key in the system diff --git a/tests/v2/features/cloudflare_integration.feature b/tests/v2/features/cloudflare_integration.feature index c4105440f9..281dbcf9f2 100644 --- a/tests/v2/features/cloudflare_integration.feature +++ b/tests/v2/features/cloudflare_integration.feature @@ -1,7 +1,9 @@ @endpoint(cloudflare-integration) @endpoint(cloudflare-integration-v2) Feature: Cloudflare Integration - 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. Background: Given a valid "apiKeyAuth" key in the system diff --git a/tests/v2/features/dora_metrics.feature b/tests/v2/features/dora_metrics.feature index 6e52ef64fc..87f233ef18 100644 --- a/tests/v2/features/dora_metrics.feature +++ b/tests/v2/features/dora_metrics.feature @@ -1,6 +1,8 @@ @endpoint(dora-metrics) @endpoint(dora-metrics-v2) Feature: DORA Metrics - 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. Background: Given a valid "apiKeyAuth" key in the system diff --git a/tests/v2/features/usage_metering.feature b/tests/v2/features/usage_metering.feature index 7a84a90e24..e29c1d396c 100644 --- a/tests/v2/features/usage_metering.feature +++ b/tests/v2/features/usage_metering.feature @@ -7,7 +7,9 @@ Feature: Usage Metering **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. + 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/). Background: Given a valid "apiKeyAuth" key in the system @@ -117,13 +119,23 @@ Feature: Usage Metering Then the response status is 400 Bad Request @team:DataDog/red-zone-revenue-query - Scenario: Get hourly usage for Lambda Traced Invocations returns "Bad Request" response + Scenario: Get hourly usage for Lambda traced invocations returns "Bad Request" response Given new "GetUsageLambdaTracedInvocations" request And request contains "start_hr" parameter with value "{{ timeISO('now - 3d') }}" And request contains "end_hr" parameter with value "{{ timeISO('now - 5d') }}" When the request is sent Then the response status is 400 Bad Request + @team:DataDog/red-zone-revenue-query + Scenario: Get hourly usage for Lambda traced invocations returns "OK" response + Given new "GetUsageLambdaTracedInvocations" request + And request contains "start_hr" parameter with value "{{ timeISO('now - 5d') }}" + And request contains "end_hr" parameter with value "{{ timeISO('now - 3d') }}" + When the request is sent + Then the response status is 200 OK + And the response "data[0].type" is equal to "usage_timeseries" + And the response "data[0].attributes.product_family" is equal to "lambda-traced-invocations" + @team:DataDog/red-zone-revenue-query Scenario: Get hourly usage for Observability Pipelines returns "Bad Request" response Given new "GetUsageObservabilityPipelines" request @@ -149,23 +161,6 @@ Feature: Usage Metering And the response "data[0].type" is equal to "usage_timeseries" And the response "data[0].attributes.product_family" is equal to "app-sec" - @generated @skip @team:DataDog/red-zone-revenue-query - Scenario: Get hourly usage for lambda traced invocations returns "Bad Request" response - Given new "GetUsageLambdaTracedInvocations" request - And request contains "start_hr" parameter from "REPLACE.ME" - When the request is sent - Then the response status is 400 Bad Request - - @team:DataDog/red-zone-revenue-query - Scenario: Get hourly usage for lambda traced invocations returns "OK" response - Given new "GetUsageLambdaTracedInvocations" request - And request contains "start_hr" parameter with value "{{ timeISO('now - 5d') }}" - And request contains "end_hr" parameter with value "{{ timeISO('now - 3d') }}" - When the request is sent - Then the response status is 200 OK - And the response "data[0].type" is equal to "usage_timeseries" - And the response "data[0].attributes.product_family" is equal to "lambda-traced-invocations" - @generated @skip @team:DataDog/red-zone-revenue-query Scenario: Get hourly usage for observability pipelines returns "Bad Request" response Given new "GetUsageObservabilityPipelines" request