Skip to content

Commit 0136839

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Clarify need of non-scoped app keys for some log endpoints (#2270)
* Regenerate client from commit f858f395 of spec repo * pre-commit fixes --------- Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 94da511 commit 0136839

File tree

11 files changed

+40
-23
lines changed

11 files changed

+40
-23
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-11-18 20:17:00.322824",
8-
"spec_repo_commit": "1939caa6"
7+
"regenerated": "2024-11-19 18:07:17.903802",
8+
"spec_repo_commit": "f858f395"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-11-18 20:17:00.340566",
13-
"spec_repo_commit": "1939caa6"
12+
"regenerated": "2024-11-19 18:07:17.921127",
13+
"spec_repo_commit": "f858f395"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36442,7 +36442,8 @@ tags:
3644236442
name: Logs
3644336443
- description: 'Manage configuration of [log indexes](https://docs.datadoghq.com/logs/indexes/).
3644436444

36445-
You need an API and application key with Admin rights to interact with this endpoint.'
36445+
You need an API and non-scoped application key with Admin rights to interact with
36446+
these endpoints.'
3644636447
externalDocs:
3644736448
description: Find out more at
3644836449
url: https://docs.datadoghq.com/logs/indexes/
@@ -36454,11 +36455,12 @@ tags:
3645436455
about processors can be found in the\n [processors documentation](https://docs.datadoghq.com/logs/log_configuration/processors/?tab=api#lookup-processor).\n\n-
3645536456
For more information about Pipelines, see the\n [pipeline documentation](https://docs.datadoghq.com/logs/log_configuration/pipelines).\n\n**Notes:**\n\nThese
3645636457
endpoints are only available for admin users.\nMake sure to use an application
36457-
key created by an admin.\n\n**Grok parsing rules may effect JSON output and require\nreturned
36458-
data to be configured before using in a request.**\nFor example, if you are using
36459-
the data returned from a\nrequest for another request body, and have a parsing
36460-
rule\nthat uses a regex pattern like `\\s` for spaces, you will\nneed to configure
36461-
all escaped spaces as `%{space}` to use\nin the body data."
36458+
key created by an admin with no applied scopes.\n\n**Grok parsing rules may effect
36459+
JSON output and require\nreturned data to be configured before using in a request.**\nFor
36460+
example, if you are using the data returned from a\nrequest for another request
36461+
body, and have a parsing rule\nthat uses a regex pattern like `\\s` for spaces,
36462+
you will\nneed to configure all escaped spaces as `%{space}` to use\nin the body
36463+
data."
3646236464
externalDocs:
3646336465
description: Find out more at
3646436466
url: https://docs.datadoghq.com/logs/log_configuration

.generator/schemas/v2/openapi.yaml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43830,7 +43830,11 @@ tags:
4383043830

4383143831
See the [Archives Page](https://app.datadoghq.com/logs/pipelines/archives)
4383243832

43833-
for a list of the archives currently configured in Datadog.'
43833+
for a list of the archives currently configured in Datadog.
43834+
43835+
43836+
You need an API and non-scoped application key with Admin rights to interact with
43837+
these endpoints.'
4383443838
externalDocs:
4383543839
description: Find out more at
4383643840
url: https://docs.datadoghq.com/logs/archives/
@@ -43849,8 +43853,11 @@ tags:
4384943853
description: Find out more at
4385043854
url: https://docs.datadoghq.com/logs/log_configuration/forwarding_custom_destinations/
4385143855
name: Logs Custom Destinations
43852-
- description: Manage configuration of [log-based metrics](https://app.datadoghq.com/logs/pipelines/generate-metrics)
43856+
- description: 'Manage configuration of [log-based metrics](https://app.datadoghq.com/logs/pipelines/generate-metrics)
4385343857
for your organization.
43858+
43859+
You need an API and non-scoped application key with Admin rights to interact with
43860+
these endpoints.'
4385443861
externalDocs:
4385543862
description: Find out more at
4385643863
url: https://docs.datadoghq.com/logs/logs_to_metrics/

src/datadog_api_client/v1/api/logs_indexes_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
class LogsIndexesApi:
1717
"""
1818
Manage configuration of `log indexes <https://docs.datadoghq.com/logs/indexes/>`_.
19-
You need an API and application key with Admin rights to interact with this endpoint.
19+
You need an API and non-scoped application key with Admin rights to interact with these endpoints.
2020
"""
2121

2222
def __init__(self, api_client=None):

src/datadog_api_client/v1/api/logs_pipelines_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class LogsPipelinesApi:
3232
**Notes:**
3333
3434
These endpoints are only available for admin users.
35-
Make sure to use an application key created by an admin.
35+
Make sure to use an application key created by an admin with no applied scopes.
3636
3737
**Grok parsing rules may effect JSON output and require
3838
returned data to be configured before using in a request.**

src/datadog_api_client/v2/api/logs_archives_api.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ class LogsArchivesApi:
2121
2222
See the `Archives Page <https://app.datadoghq.com/logs/pipelines/archives>`_
2323
for a list of the archives currently configured in Datadog.
24+
25+
You need an API and non-scoped application key with Admin rights to interact with these endpoints.
2426
"""
2527

2628
def __init__(self, api_client=None):

src/datadog_api_client/v2/api/logs_metrics_api.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
class LogsMetricsApi:
1717
"""
1818
Manage configuration of `log-based metrics <https://app.datadoghq.com/logs/pipelines/generate-metrics>`_ for your organization.
19+
You need an API and non-scoped application key with Admin rights to interact with these endpoints.
1920
"""
2021

2122
def __init__(self, api_client=None):

tests/v1/features/logs_indexes.feature

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
Feature: Logs Indexes
33
Manage configuration of [log
44
indexes](https://docs.datadoghq.com/logs/indexes/). You need an API and
5-
application key with Admin rights to interact with this endpoint.
5+
non-scoped application key with Admin rights to interact with these
6+
endpoints.
67

78
Background:
89
Given a valid "apiKeyAuth" key in the system

tests/v1/features/logs_pipelines.feature

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,13 @@ Feature: Logs Pipelines
1010
s/?tab=api#lookup-processor). - For more information about Pipelines, see
1111
the [pipeline documentation](https://docs.datadoghq.com/logs/log_configu
1212
ration/pipelines). **Notes:** These endpoints are only available for
13-
admin users. Make sure to use an application key created by an admin.
14-
**Grok parsing rules may effect JSON output and require returned data to
15-
be configured before using in a request.** For example, if you are using
16-
the data returned from a request for another request body, and have a
17-
parsing rule that uses a regex pattern like `\s` for spaces, you will need
18-
to configure all escaped spaces as `%{space}` to use in the body data.
13+
admin users. Make sure to use an application key created by an admin with
14+
no applied scopes. **Grok parsing rules may effect JSON output and
15+
require returned data to be configured before using in a request.** For
16+
example, if you are using the data returned from a request for another
17+
request body, and have a parsing rule that uses a regex pattern like `\s`
18+
for spaces, you will need to configure all escaped spaces as `%{space}` to
19+
use in the body data.
1920

2021
Background:
2122
Given a valid "apiKeyAuth" key in the system

tests/v2/features/logs_archives.feature

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
Feature: Logs Archives
33
Archives forward all the logs ingested to a cloud storage system. See the
44
[Archives Page](https://app.datadoghq.com/logs/pipelines/archives) for a
5-
list of the archives currently configured in Datadog.
5+
list of the archives currently configured in Datadog. You need an API and
6+
non-scoped application key with Admin rights to interact with these
7+
endpoints.
68

79
Background:
810
Given a valid "apiKeyAuth" key in the system

0 commit comments

Comments
 (0)