Skip to content

Commit c25261a

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
(DOCS-7109) Add overview details and doc links (#1497)
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 67c68b3 commit c25261a

File tree

29 files changed

+180
-184
lines changed

29 files changed

+180
-184
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:18.607321",
8-
"spec_repo_commit": "7def3c63"
7+
"regenerated": "2024-01-24 20:59:46.831321",
8+
"spec_repo_commit": "9d7a3d85"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-01-22 19:09:18.627809",
13-
"spec_repo_commit": "7def3c63"
12+
"regenerated": "2024-01-24 20:59:46.846226",
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/

cassettes/v2/Usage-Metering_938753175/Get-hourly-usage-for-Lambda-Traced-Invocations-returns-Bad-Request-response_3268857775/frozen.json

Lines changed: 0 additions & 1 deletion
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2024-01-24T20:56:23.911Z"
Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
{
22
"log": {
3-
"_recordingName": "Usage Metering/Get hourly usage for Lambda Traced Invocations returns \"Bad Request\" response",
3+
"_recordingName": "Usage Metering/Get hourly usage for Lambda traced invocations returns \"Bad Request\" response",
44
"creator": {
55
"comment": "persister:fs",
66
"name": "Polly.JS",
77
"version": "6.0.5"
88
},
99
"entries": [
1010
{
11-
"_id": "d19a05076404164d8f0def0c128f076f",
11+
"_id": "af201a681472acf2fa02feb5049e78f4",
1212
"_order": 0,
1313
"cache": {},
1414
"request": {
@@ -27,21 +27,21 @@
2727
"queryString": [
2828
{
2929
"name": "start_hr",
30-
"value": "2022-05-03T18:07:36.174Z"
30+
"value": "2024-01-21T20:56:23.911Z"
3131
},
3232
{
3333
"name": "end_hr",
34-
"value": "2022-05-01T18:07:36.174Z"
34+
"value": "2024-01-19T20:56:23.911Z"
3535
}
3636
],
37-
"url": "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"
37+
"url": "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"
3838
},
3939
"response": {
40-
"bodySize": 78,
40+
"bodySize": 77,
4141
"content": {
4242
"mimeType": "application/json",
43-
"size": 78,
44-
"text": "{\"errors\":[\"start_hr [YYYY-MM-DDThh] must be before end_hr [YYYY-MM-DDThh]\"]}\n"
43+
"size": 77,
44+
"text": "{\"errors\":[\"start_hr [YYYY-MM-DDThh] must be before end_hr [YYYY-MM-DDThh]\"]}"
4545
},
4646
"cookies": [],
4747
"headers": [
@@ -50,14 +50,14 @@
5050
"value": "application/json"
5151
}
5252
],
53-
"headersSize": 665,
53+
"headersSize": 648,
5454
"httpVersion": "HTTP/1.1",
5555
"redirectURL": "",
5656
"status": 400,
5757
"statusText": "Bad Request"
5858
},
59-
"startedDateTime": "2022-05-06T18:07:36.195Z",
60-
"time": 254
59+
"startedDateTime": "2024-01-24T20:56:23.940Z",
60+
"time": 548
6161
}
6262
],
6363
"pages": [],
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2024-01-24T20:54:39.781Z"
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
{
2+
"log": {
3+
"_recordingName": "Usage Metering/Get hourly usage for Lambda traced invocations returns \"OK\" response",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "f98e6a11f85ef6a5fe2d415bfb559ab0",
12+
"_order": 0,
13+
"cache": {},
14+
"request": {
15+
"bodySize": 0,
16+
"cookies": [],
17+
"headers": [
18+
{
19+
"_fromType": "array",
20+
"name": "accept",
21+
"value": "application/json;datetime-format=rfc3339"
22+
}
23+
],
24+
"headersSize": 641,
25+
"httpVersion": "HTTP/1.1",
26+
"method": "GET",
27+
"queryString": [
28+
{
29+
"name": "start_hr",
30+
"value": "2024-01-19T20:54:39.781Z"
31+
},
32+
{
33+
"name": "end_hr",
34+
"value": "2024-01-21T20:54:39.781Z"
35+
}
36+
],
37+
"url": "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"
38+
},
39+
"response": {
40+
"bodySize": 2961,
41+
"content": {
42+
"mimeType": "application/json",
43+
"size": 2961,
44+
"text": "{\"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}]}}]}\n"
45+
},
46+
"cookies": [],
47+
"headers": [
48+
{
49+
"name": "content-type",
50+
"value": "application/json"
51+
}
52+
],
53+
"headersSize": 651,
54+
"httpVersion": "HTTP/1.1",
55+
"redirectURL": "",
56+
"status": 200,
57+
"statusText": "OK"
58+
},
59+
"startedDateTime": "2024-01-24T20:54:39.809Z",
60+
"time": 1010
61+
}
62+
],
63+
"pages": [],
64+
"version": "1.2"
65+
}
66+
}

cassettes/v2/Usage-Metering_938753175/Get-hourly-usage-for-lambda-traced-invocations-returns-OK-response_2164867579/frozen.json

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)