Skip to content

Commit 516e24a

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
(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>
1 parent 61a5d21 commit 516e24a

36 files changed

+126
-126
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2024-01-22 19:09:10.417108",
8-
"spec_repo_commit": "7def3c63"
7+
"regenerated": "2024-01-24 20:59:43.240865",
8+
"spec_repo_commit": "9d7a3d85"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-01-22 19:09:10.431037",
13-
"spec_repo_commit": "7def3c63"
12+
"regenerated": "2024-01-24 20:59:43.256115",
13+
"spec_repo_commit": "9d7a3d85"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,7 @@ components:
328328
type: string
329329
message:
330330
description: Message content.
331-
example: AWS account 12345 has no lambda config to update
331+
example: AWS account 12345 has no Lambda config to update
332332
type: string
333333
type: object
334334
AWSLogsAsyncResponse:
@@ -18067,7 +18067,7 @@ components:
1806718067
type: array
1806818068
type: object
1806918069
UsageLambdaHour:
18070-
description: 'Number of lambda functions and sum of the invocations of all lambda
18070+
description: 'Number of Lambda functions and sum of the invocations of all Lambda
1807118071
functions
1807218072

1807318073
for each hour for a given organization.'
@@ -18095,8 +18095,8 @@ components:
1809518095
type: string
1809618096
type: object
1809718097
UsageLambdaResponse:
18098-
description: 'Response containing the number of lambda functions and sum of
18099-
the invocations of all lambda functions
18098+
description: 'Response containing the number of Lambda functions and sum of
18099+
the invocations of all Lambda functions
1810018100

1810118101
for each hour for a given organization.'
1810218102
properties:
@@ -31170,7 +31170,7 @@ paths:
3117031170
- Usage Metering
3117131171
/api/v1/usage/aws_lambda:
3117231172
get:
31173-
description: 'Get hourly usage for lambda.
31173+
description: 'Get hourly usage for Lambda.
3117431174

3117531175
**Note:** hourly usage data for all products is now available in the [Get
3117631176
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:
3122431224
appKeyAuth: []
3122531225
- AuthZ:
3122631226
- usage_read
31227-
summary: Get hourly usage for lambda
31227+
summary: Get hourly usage for Lambda
3122831228
tags:
3122931229
- Usage Metering
3123031230
/api/v1/usage/billable-summary:
@@ -33573,17 +33573,19 @@ tags:
3357333573
- description: 'Configure your Datadog-AWS-Logs integration directly through Datadog
3357433574
API.
3357533575

33576-
For more information, see the [AWS integration page](https://docs.datadoghq.com/api/?lang=bash#integration-aws-logs).'
33576+
For more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection).'
3357733577
externalDocs:
33578-
url: https://docs.datadoghq.com/api/?lang=bash#integration-aws-logs
33578+
url: https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection
3357933579
name: AWS Logs Integration
3358033580
- description: "All requests to Datadog\u2019s API must be authenticated.\nRequests
3358133581
that write data require reporting access and require an `API key`.\nRequests that
3358233582
read data require full access and also require an `application key`.\n\n**Note:**
3358333583
All Datadog API clients are configured by default to consume Datadog US site APIs.\nIf
3358433584
you are on the Datadog EU site, set the environment variable `DATADOG_HOST` to\n`https://api.datadoghq.eu`
3358533585
or override this value directly when creating your client.\n\n[Manage your account\u2019s
33586-
API and application keys](https://app.datadoghq.com/account/settings#api)."
33586+
API and application keys](https://app.datadoghq.com/organization-settings/) in
33587+
Datadog, and see the [API and Application Keys page](https://docs.datadoghq.com/account_management/api-app-keys/)
33588+
in the documentation."
3358733589
name: Authentication
3358833590
- description: 'Configure your Datadog-Azure integration directly through the Datadog
3358933591
API.
@@ -33826,7 +33828,9 @@ tags:
3382633828

3382733829
You can retrieve up to 24 hours of hourly usage data for multiple organizations,
3382833830

33829-
and up to two months of hourly usage data for a single organization in one request.'
33831+
and up to two months of hourly usage data for a single organization in one request.
33832+
33833+
Learn more on the [usage details documentation](https://docs.datadoghq.com/account_management/billing/usage_details/).'
3383033834
externalDocs:
3383133835
description: Find out more at
3383233836
url: https://docs.datadoghq.com/account_management/billing/usage_details/

.generator/schemas/v2/openapi.yaml

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32532,7 +32532,7 @@ paths:
3253232532
- Usage Metering
3253332533
/api/v2/usage/lambda_traced_invocations:
3253432534
get:
32535-
description: 'Get hourly usage for lambda traced invocations.
32535+
description: 'Get hourly usage for Lambda traced invocations.
3253632536

3253732537
**Note:** hourly usage data for all products is now available in the [Get
3253832538
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:
3258632586
appKeyAuth: []
3258732587
- AuthZ:
3258832588
- usage_read
32589-
summary: Get hourly usage for lambda traced invocations
32589+
summary: Get hourly usage for Lambda traced invocations
3259032590
tags:
3259132591
- Usage Metering
3259232592
/api/v2/usage/observability_pipelines:
@@ -33172,32 +33172,39 @@ servers:
3317233172
tags:
3317333173
- description: Manage configuration of [APM retention filters](https://app.datadoghq.com/apm/traces/retention-filters)
3317433174
for your organization. You need an API and application key with Admin rights to
33175-
interact with this endpoint.
33175+
interact with this endpoint. See [retention filters](https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/#retention-filters)
33176+
on the Trace Retention page for more information.
3317633177
externalDocs:
3317733178
description: Find out more at
3317833179
url: https://docs.datadoghq.com/tracing/trace_pipeline/trace_retention/
3317933180
name: APM Retention Filters
3318033181
- description: Search your Audit Logs events over HTTP.
3318133182
name: Audit
33182-
- description: '[AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example)
33183+
- description: '[The AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example)
3318333184

33184-
is used to automatically map group of users to roles in Datadog using attributes
33185+
is used to automatically map groups of users to roles in Datadog using attributes
3318533186

33186-
sent from Identity Providers.'
33187+
sent from Identity Providers. Use these endpoints to manage your AuthN Mappings.'
3318733188
name: AuthN Mappings
3318833189
- description: Search or aggregate your CI Visibility pipeline events and send them
33189-
to your Datadog site over HTTP.
33190+
to your Datadog site over HTTP. See the [CI Pipeline Visibility in Datadog page](https://docs.datadoghq.com/continuous_integration/pipelines/)
33191+
for more information.
3319033192
name: CI Visibility Pipelines
33191-
- description: Search or aggregate your CI Visibility test events over HTTP.
33193+
- description: Search or aggregate your CI Visibility test events over HTTP. See the
33194+
[Test Visibility in Datadog page](https://docs.datadoghq.com/tests/) for more
33195+
information.
3319233196
name: CI Visibility Tests
33193-
- description: The Cloud Cost Management API allows you to setup, edit and delete
33194-
cloud cost management accounts for AWS & Azure.
33197+
- description: The Cloud Cost Management API allows you to set up, edit, and delete
33198+
Cloud Cost Management accounts for AWS and Azure. See the [Cloud Cost Management
33199+
page](https://docs.datadoghq.com/cloud_cost_management/) for more information.
3319533200
name: Cloud Cost Management
3319633201
- description: Workload activity security rules for generating events using the Datadog
33197-
security Agent.
33202+
security Agent. See the [Setting up CSM Workload Security page](https://docs.datadoghq.com/security/cloud_security_management/setup/csm_workload_security/)
33203+
for more information.
3319833204
name: Cloud Workload Security
33199-
- description: Configure your Datadog Cloudflare integration directly through the
33200-
Datadog API.
33205+
- description: Manage your Datadog Cloudflare integration directly through the Datadog
33206+
API. See the [Cloudflare integration page](https://docs.datadoghq.com/integrations/cloudflare/)
33207+
for more information.
3320133208
name: Cloudflare Integration
3320233209
- description: Configure your Datadog Confluent Cloud integration directly through
3320333210
the Datadog API.
@@ -33208,6 +33215,8 @@ tags:
3320833215
- description: The Containers API allows you to query container data for your organization.
3320933216
name: Containers
3321033217
- description: Send events for DORA Metrics to measure and improve software delivery.
33218+
See the [DORA Metrics page](https://docs.datadoghq.com/dora_metrics/) for more
33219+
information.
3321133220
name: DORA Metrics
3321233221
- description: 'Interact with your dashboard lists through the API to
3321333222

@@ -33429,7 +33438,9 @@ tags:
3342933438

3343033439
You can retrieve up to 24 hours of hourly usage data for multiple organizations,
3343133440

33432-
and up to two months of hourly usage data for a single organization in one request.'
33441+
and up to two months of hourly usage data for a single organization in one request.
33442+
33443+
Learn more on the [usage details documentation](https://docs.datadoghq.com/account_management/billing/usage_details/).'
3343333444
externalDocs:
3343433445
description: Find out more at
3343533446
url: https://docs.datadoghq.com/account_management/billing/usage_details/
Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
"""
2-
Get hourly usage for lambda returns "OK" response
2+
Get hourly usage for Lambda returns "OK" response
33
"""
44

5+
from datetime import datetime
6+
from dateutil.relativedelta import relativedelta
57
from datadog_api_client import ApiClient, Configuration
68
from datadog_api_client.v1.api.usage_metering_api import UsageMeteringApi
7-
from datetime import datetime
8-
from dateutil.tz import tzutc
99

1010
configuration = Configuration()
1111
with ApiClient(configuration) as api_client:
1212
api_instance = UsageMeteringApi(api_client)
1313
response = api_instance.get_usage_lambda(
14-
start_hr=datetime(2021, 11, 11, 11, 11, 11, 111000, tzinfo=tzutc()),
14+
start_hr=(datetime.now() + relativedelta(days=-5)),
15+
end_hr=(datetime.now() + relativedelta(days=-3)),
1516
)
1617

1718
print(response)

examples/v1/usage-metering/GetUsageLambda_3132428705.py

Lines changed: 0 additions & 18 deletions
This file was deleted.

examples/v2/usage-metering/GetUsageLambdaTracedInvocations.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Get hourly usage for lambda traced invocations returns "OK" response
2+
Get hourly usage for Lambda traced invocations returns "OK" response
33
"""
44

55
from datetime import datetime

src/datadog_api_client/v1/api/authentication_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class AuthenticationApi:
2020
If you are on the Datadog EU site, set the environment variable ``DATADOG_HOST`` to
2121
``https://api.datadoghq.eu`` or override this value directly when creating your client.
2222
23-
`Manage your account’s API and application keys <https://app.datadoghq.com/account/settings#api>`_.
23+
`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.
2424
"""
2525

2626
def __init__(self, api_client=None):

src/datadog_api_client/v1/api/aws_logs_integration_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
class AWSLogsIntegrationApi:
1818
"""
1919
Configure your Datadog-AWS-Logs integration directly through Datadog API.
20-
For more information, see the `AWS integration page <https://docs.datadoghq.com/api/?lang=bash#integration-aws-logs>`_.
20+
For more information, see the `AWS integration page <https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection>`_.
2121
"""
2222

2323
def __init__(self, api_client=None):

src/datadog_api_client/v1/api/usage_metering_api.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ class UsageMeteringApi:
7373
7474
You can retrieve up to 24 hours of hourly usage data for multiple organizations,
7575
and up to two months of hourly usage data for a single organization in one request.
76+
Learn more on the `usage details documentation <https://docs.datadoghq.com/account_management/billing/usage_details/>`_.
7677
"""
7778

7879
def __init__(self, api_client=None):
@@ -1922,9 +1923,9 @@ def get_usage_lambda(
19221923
*,
19231924
end_hr: Union[datetime, UnsetType] = unset,
19241925
) -> UsageLambdaResponse:
1925-
"""Get hourly usage for lambda.
1926+
"""Get hourly usage for Lambda.
19261927
1927-
Get hourly usage for lambda.
1928+
Get hourly usage for Lambda.
19281929
**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.
19291930
19301931
: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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def __init__(
4444
**kwargs,
4545
):
4646
"""
47-
Number of lambda functions and sum of the invocations of all lambda functions
47+
Number of Lambda functions and sum of the invocations of all Lambda functions
4848
for each hour for a given organization.
4949
5050
:param func_count: Contains the number of different functions for each region and AWS account.

0 commit comments

Comments
 (0)