Skip to content

Commit b800448

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Patch open Logs routes with logs_read_config permission (#2368)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent d88953b commit b800448

File tree

11 files changed

+55
-66
lines changed

11 files changed

+55
-66
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": "2025-01-24 20:40:50.935454",
8-
"spec_repo_commit": "c6ec55eb"
7+
"regenerated": "2025-01-27 15:14:15.089106",
8+
"spec_repo_commit": "333d42be"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-01-24 20:40:50.958148",
13-
"spec_repo_commit": "c6ec55eb"
12+
"regenerated": "2025-01-27 15:14:15.104235",
13+
"spec_repo_commit": "333d42be"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -28362,8 +28362,9 @@ paths:
2836228362
tags:
2836328363
- Logs Indexes
2836428364
x-permission:
28365-
operator: OPEN
28366-
permissions: []
28365+
operator: OR
28366+
permissions:
28367+
- logs_read_config
2836728368
put:
2836828369
description: 'This endpoint updates the index order of your organization.
2836928370

@@ -28435,8 +28436,9 @@ paths:
2843528436
tags:
2843628437
- Logs Indexes
2843728438
x-permission:
28438-
operator: OPEN
28439-
permissions: []
28439+
operator: OR
28440+
permissions:
28441+
- logs_read_config
2844028442
post:
2844128443
description: Creates a new index. Returns the Index object passed in the request
2844228444
body when the request is successful.
@@ -28513,6 +28515,10 @@ paths:
2851328515
summary: Get an index
2851428516
tags:
2851528517
- Logs Indexes
28518+
x-permission:
28519+
operator: OR
28520+
permissions:
28521+
- logs_read_config
2851628522
put:
2851728523
description: "Update an index as identified by its name.\nReturns the Index
2851828524
object passed in the request body when the request is successful.\n\nUsing
@@ -28587,8 +28593,9 @@ paths:
2858728593
tags:
2858828594
- Logs Pipelines
2858928595
x-permission:
28590-
operator: OPEN
28591-
permissions: []
28596+
operator: OR
28597+
permissions:
28598+
- logs_read_config
2859228599
put:
2859328600
description: 'Update the order of your pipelines. Since logs are processed sequentially,
2859428601
reordering a pipeline may change
@@ -28669,8 +28676,9 @@ paths:
2866928676
tags:
2867028677
- Logs Pipelines
2867128678
x-permission:
28672-
operator: OPEN
28673-
permissions: []
28679+
operator: OR
28680+
permissions:
28681+
- logs_read_config
2867428682
post:
2867528683
description: Create a pipeline in your organization.
2867628684
operationId: CreateLogsPipeline
@@ -28784,8 +28792,9 @@ paths:
2878428792
tags:
2878528793
- Logs Pipelines
2878628794
x-permission:
28787-
operator: OPEN
28788-
permissions: []
28795+
operator: OR
28796+
permissions:
28797+
- logs_read_config
2878928798
put:
2879028799
description: "Update a given pipeline configuration to change it\u2019s processors
2879128800
or their order.\n\n**Note**: Using this method updates your pipeline configuration
@@ -36578,10 +36587,7 @@ tags:
3657836587
- description: Search your logs and send them to your Datadog platform over HTTP.
3657936588
See the [Log Management page](https://docs.datadoghq.com/logs/) for more information.
3658036589
name: Logs
36581-
- description: 'Manage configuration of [log indexes](https://docs.datadoghq.com/logs/indexes/).
36582-
36583-
You need an API and non-scoped application key with Admin rights to interact with
36584-
these endpoints.'
36590+
- description: Manage configuration of [log indexes](https://docs.datadoghq.com/logs/indexes/).
3658536591
externalDocs:
3658636592
description: Find out more at
3658736593
url: https://docs.datadoghq.com/logs/indexes/
@@ -36591,14 +36597,12 @@ tags:
3659136597
page](https://app.datadoghq.com/logs/pipelines)\n for a list of the pipelines
3659236598
and processors currently configured in web UI.\n\n- Additional API-related information
3659336599
about processors can be found in the\n [processors documentation](https://docs.datadoghq.com/logs/log_configuration/processors/?tab=api#lookup-processor).\n\n-
36594-
For more information about Pipelines, see the\n [pipeline documentation](https://docs.datadoghq.com/logs/log_configuration/pipelines).\n\n**Notes:**\n\nThese
36595-
endpoints are only available for admin users.\nMake sure to use an application
36596-
key created by an admin with no applied scopes.\n\n**Grok parsing rules may effect
36597-
JSON output and require\nreturned data to be configured before using in a request.**\nFor
36598-
example, if you are using the data returned from a\nrequest for another request
36599-
body, and have a parsing rule\nthat uses a regex pattern like `\\s` for spaces,
36600-
you will\nneed to configure all escaped spaces as `%{space}` to use\nin the body
36601-
data."
36600+
For more information about Pipelines, see the\n [pipeline documentation](https://docs.datadoghq.com/logs/log_configuration/pipelines).\n\n**Notes:**\n\n**Grok
36601+
parsing rules may effect JSON output and require\nreturned data to be configured
36602+
before using in a request.**\nFor example, if you are using the data returned
36603+
from a\nrequest for another request body, and have a parsing rule\nthat uses a
36604+
regex pattern like `\\s` for spaces, you will\nneed to configure all escaped spaces
36605+
as `%{space}` to use\nin the body data."
3660236606
externalDocs:
3660336607
description: Find out more at
3660436608
url: https://docs.datadoghq.com/logs/log_configuration

.generator/schemas/v2/openapi.yaml

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -38944,8 +38944,9 @@ paths:
3894438944
tags:
3894538945
- Logs Archives
3894638946
x-permission:
38947-
operator: OPEN
38948-
permissions: []
38947+
operator: OR
38948+
permissions:
38949+
- logs_read_config
3894938950
put:
3895038951
description: 'Update the order of your archives. Since logs are processed sequentially,
3895138952
reordering an archive may change
@@ -39272,8 +39273,9 @@ paths:
3927239273
- Logs Archives
3927339274
x-codegen-request-body-name: body
3927439275
x-permission:
39275-
operator: OPEN
39276-
permissions: []
39276+
operator: OR
39277+
permissions:
39278+
- logs_read_config
3927739279
post:
3927839280
description: Adds a read role to an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))
3927939281
operationId: AddReadRoleToArchive
@@ -39343,6 +39345,7 @@ paths:
3934339345
operator: OR
3934439346
permissions:
3934539347
- logs_read_data
39348+
- logs_read_config
3934639349
post:
3934739350
description: Create a custom destination in your organization.
3934839351
operationId: CreateLogsCustomDestination
@@ -39427,6 +39430,7 @@ paths:
3942739430
operator: OR
3942839431
permissions:
3942939432
- logs_read_data
39433+
- logs_read_config
3943039434
patch:
3943139435
description: Update the given fields of a specific custom destination in your
3943239436
organization.
@@ -39484,8 +39488,9 @@ paths:
3948439488
tags:
3948539489
- Logs Metrics
3948639490
x-permission:
39487-
operator: OPEN
39488-
permissions: []
39491+
operator: OR
39492+
permissions:
39493+
- logs_read_config
3948939494
post:
3949039495
description: 'Create a metric based on your ingested logs in your organization.
3949139496

@@ -39566,8 +39571,9 @@ paths:
3956639571
tags:
3956739572
- Logs Metrics
3956839573
x-permission:
39569-
operator: OPEN
39570-
permissions: []
39574+
operator: OR
39575+
permissions:
39576+
- logs_read_config
3957139577
patch:
3957239578
description: 'Update a specific log-based metric from your organization.
3957339579

@@ -49742,11 +49748,7 @@ tags:
4974249748

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

49745-
for a list of the archives currently configured in Datadog.
49746-
49747-
49748-
You need an API and non-scoped application key with Admin rights to interact with
49749-
these endpoints.'
49751+
for a list of the archives currently configured in Datadog.'
4975049752
externalDocs:
4975149753
description: Find out more at
4975249754
url: https://docs.datadoghq.com/logs/archives/
@@ -49765,11 +49767,8 @@ tags:
4976549767
description: Find out more at
4976649768
url: https://docs.datadoghq.com/logs/log_configuration/forwarding_custom_destinations/
4976749769
name: Logs Custom Destinations
49768-
- description: 'Manage configuration of [log-based metrics](https://app.datadoghq.com/logs/pipelines/generate-metrics)
49770+
- description: Manage configuration of [log-based metrics](https://app.datadoghq.com/logs/pipelines/generate-metrics)
4976949771
for your organization.
49770-
49771-
You need an API and non-scoped application key with Admin rights to interact with
49772-
these endpoints.'
4977349772
externalDocs:
4977449773
description: Find out more at
4977549774
url: https://docs.datadoghq.com/logs/logs_to_metrics/

src/datadog_api_client/v1/api/logs_indexes_api.py

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

2221
def __init__(self, api_client=None):

src/datadog_api_client/v1/api/logs_pipelines_api.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,6 @@ class LogsPipelinesApi:
3131
3232
**Notes:**
3333
34-
These endpoints are only available for admin users.
35-
Make sure to use an application key created by an admin with no applied scopes.
36-
3734
**Grok parsing rules may effect JSON output and require
3835
returned data to be configured before using in a request.**
3936
For example, if you are using the data returned from a

src/datadog_api_client/v2/api/logs_archives_api.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@ 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.
2624
"""
2725

2826
def __init__(self, api_client=None):

src/datadog_api_client/v2/api/logs_metrics_api.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
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.
2019
"""
2120

2221
def __init__(self, api_client=None):

tests/v1/features/logs_indexes.feature

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
@endpoint(logs-indexes) @endpoint(logs-indexes-v1)
22
Feature: Logs Indexes
33
Manage configuration of [log
4-
indexes](https://docs.datadoghq.com/logs/indexes/). You need an API and
5-
non-scoped application key with Admin rights to interact with these
6-
endpoints.
4+
indexes](https://docs.datadoghq.com/logs/indexes/).
75

86
Background:
97
Given a valid "apiKeyAuth" key in the system

tests/v1/features/logs_pipelines.feature

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,12 @@ Feature: Logs Pipelines
99
documentation](https://docs.datadoghq.com/logs/log_configuration/processor
1010
s/?tab=api#lookup-processor). - For more information about Pipelines, see
1111
the [pipeline documentation](https://docs.datadoghq.com/logs/log_configu
12-
ration/pipelines). **Notes:** These endpoints are only available for
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.
12+
ration/pipelines). **Notes:** **Grok parsing rules may effect JSON
13+
output and require returned data to be configured before using in a
14+
request.** For example, if you are using the data returned from a request
15+
for another request body, and have a parsing rule that uses a regex
16+
pattern like `\s` for spaces, you will need to configure all escaped
17+
spaces as `%{space}` to use in the body data.
2018

2119
Background:
2220
Given a valid "apiKeyAuth" key in the system

tests/v2/features/logs_archives.feature

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
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. You need an API and
6-
non-scoped application key with Admin rights to interact with these
7-
endpoints.
5+
list of the archives currently configured in Datadog.
86

97
Background:
108
Given a valid "apiKeyAuth" key in the system

0 commit comments

Comments
 (0)