Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Patch open Logs routes with logs_read_config permission #2888

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2025-01-21 14:16:33.980025",
"spec_repo_commit": "0bbc13ae"
"regenerated": "2025-01-22 16:01:29.409529",
"spec_repo_commit": "db122aa0"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-01-21 14:16:33.995142",
"spec_repo_commit": "0bbc13ae"
"regenerated": "2025-01-22 16:01:29.425015",
"spec_repo_commit": "db122aa0"
}
}
}
48 changes: 26 additions & 22 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28348,8 +28348,9 @@ paths:
tags:
- Logs Indexes
x-permission:
operator: OPEN
permissions: []
operator: OR
permissions:
- logs_read_config
put:
description: 'This endpoint updates the index order of your organization.

Expand Down Expand Up @@ -28421,8 +28422,9 @@ paths:
tags:
- Logs Indexes
x-permission:
operator: OPEN
permissions: []
operator: OR
permissions:
- logs_read_config
post:
description: Creates a new index. Returns the Index object passed in the request
body when the request is successful.
Expand Down Expand Up @@ -28499,6 +28501,10 @@ paths:
summary: Get an index
tags:
- Logs Indexes
x-permission:
operator: OR
permissions:
- logs_read_config
put:
description: "Update an index as identified by its name.\nReturns the Index
object passed in the request body when the request is successful.\n\nUsing
Expand Down Expand Up @@ -28573,8 +28579,9 @@ paths:
tags:
- Logs Pipelines
x-permission:
operator: OPEN
permissions: []
operator: OR
permissions:
- logs_read_config
put:
description: 'Update the order of your pipelines. Since logs are processed sequentially,
reordering a pipeline may change
Expand Down Expand Up @@ -28655,8 +28662,9 @@ paths:
tags:
- Logs Pipelines
x-permission:
operator: OPEN
permissions: []
operator: OR
permissions:
- logs_read_config
post:
description: Create a pipeline in your organization.
operationId: CreateLogsPipeline
Expand Down Expand Up @@ -28770,8 +28778,9 @@ paths:
tags:
- Logs Pipelines
x-permission:
operator: OPEN
permissions: []
operator: OR
permissions:
- logs_read_config
put:
description: "Update a given pipeline configuration to change it\u2019s processors
or their order.\n\n**Note**: Using this method updates your pipeline configuration
Expand Down Expand Up @@ -36564,10 +36573,7 @@ tags:
- description: Search your logs and send them to your Datadog platform over HTTP.
See the [Log Management page](https://docs.datadoghq.com/logs/) for more information.
name: Logs
- description: 'Manage configuration of [log indexes](https://docs.datadoghq.com/logs/indexes/).

You need an API and non-scoped application key with Admin rights to interact with
these endpoints.'
- description: Manage configuration of [log indexes](https://docs.datadoghq.com/logs/indexes/).
externalDocs:
description: Find out more at
url: https://docs.datadoghq.com/logs/indexes/
Expand All @@ -36577,14 +36583,12 @@ tags:
page](https://app.datadoghq.com/logs/pipelines)\n for a list of the pipelines
and processors currently configured in web UI.\n\n- Additional API-related information
about processors can be found in the\n [processors documentation](https://docs.datadoghq.com/logs/log_configuration/processors/?tab=api#lookup-processor).\n\n-
For more information about Pipelines, see the\n [pipeline documentation](https://docs.datadoghq.com/logs/log_configuration/pipelines).\n\n**Notes:**\n\nThese
endpoints are only available for admin users.\nMake sure to use an application
key created by an admin with no applied scopes.\n\n**Grok parsing rules may effect
JSON output and require\nreturned data to be configured before using in a request.**\nFor
example, if you are using the data returned from a\nrequest for another request
body, and have a parsing rule\nthat uses a regex pattern like `\\s` for spaces,
you will\nneed to configure all escaped spaces as `%{space}` to use\nin the body
data."
For more information about Pipelines, see the\n [pipeline documentation](https://docs.datadoghq.com/logs/log_configuration/pipelines).\n\n**Notes:**\n\n**Grok
parsing rules may effect JSON output and require\nreturned data to be configured
before using in a request.**\nFor example, if you are using the data returned
from a\nrequest for another request body, and have a parsing rule\nthat uses a
regex pattern like `\\s` for spaces, you will\nneed to configure all escaped spaces
as `%{space}` to use\nin the body data."
externalDocs:
description: Find out more at
url: https://docs.datadoghq.com/logs/log_configuration
Expand Down
33 changes: 16 additions & 17 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38643,8 +38643,9 @@ paths:
tags:
- Logs Archives
x-permission:
operator: OPEN
permissions: []
operator: OR
permissions:
- logs_read_config
put:
description: 'Update the order of your archives. Since logs are processed sequentially,
reordering an archive may change
Expand Down Expand Up @@ -38971,8 +38972,9 @@ paths:
- Logs Archives
x-codegen-request-body-name: body
x-permission:
operator: OPEN
permissions: []
operator: OR
permissions:
- logs_read_config
post:
description: Adds a read role to an archive. ([Roles API](https://docs.datadoghq.com/api/v2/roles/))
operationId: AddReadRoleToArchive
Expand Down Expand Up @@ -39042,6 +39044,7 @@ paths:
operator: OR
permissions:
- logs_read_data
- logs_read_config
post:
description: Create a custom destination in your organization.
operationId: CreateLogsCustomDestination
Expand Down Expand Up @@ -39126,6 +39129,7 @@ paths:
operator: OR
permissions:
- logs_read_data
- logs_read_config
patch:
description: Update the given fields of a specific custom destination in your
organization.
Expand Down Expand Up @@ -39183,8 +39187,9 @@ paths:
tags:
- Logs Metrics
x-permission:
operator: OPEN
permissions: []
operator: OR
permissions:
- logs_read_config
post:
description: 'Create a metric based on your ingested logs in your organization.

Expand Down Expand Up @@ -39265,8 +39270,9 @@ paths:
tags:
- Logs Metrics
x-permission:
operator: OPEN
permissions: []
operator: OR
permissions:
- logs_read_config
patch:
description: 'Update a specific log-based metric from your organization.

Expand Down Expand Up @@ -49014,11 +49020,7 @@ tags:

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

for a list of the archives currently configured in Datadog.


You need an API and non-scoped application key with Admin rights to interact with
these endpoints.'
for a list of the archives currently configured in Datadog.'
externalDocs:
description: Find out more at
url: https://docs.datadoghq.com/logs/archives/
Expand All @@ -49037,11 +49039,8 @@ tags:
description: Find out more at
url: https://docs.datadoghq.com/logs/log_configuration/forwarding_custom_destinations/
name: Logs Custom Destinations
- description: 'Manage configuration of [log-based metrics](https://app.datadoghq.com/logs/pipelines/generate-metrics)
- description: Manage configuration of [log-based metrics](https://app.datadoghq.com/logs/pipelines/generate-metrics)
for your organization.

You need an API and non-scoped application key with Admin rights to interact with
these endpoints.'
externalDocs:
description: Find out more at
url: https://docs.datadoghq.com/logs/logs_to_metrics/
Expand Down
4 changes: 1 addition & 3 deletions tests/scenarios/features/v1/logs_indexes.feature
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
@endpoint(logs-indexes) @endpoint(logs-indexes-v1)
Feature: Logs Indexes
Manage configuration of [log
indexes](https://docs.datadoghq.com/logs/indexes/). You need an API and
non-scoped application key with Admin rights to interact with these
endpoints.
indexes](https://docs.datadoghq.com/logs/indexes/).

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
14 changes: 6 additions & 8 deletions tests/scenarios/features/v1/logs_pipelines.feature
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,12 @@ Feature: Logs Pipelines
documentation](https://docs.datadoghq.com/logs/log_configuration/processor
s/?tab=api#lookup-processor). - For more information about Pipelines, see
the [pipeline documentation](https://docs.datadoghq.com/logs/log_configu
ration/pipelines). **Notes:** These endpoints are only available for
admin users. Make sure to use an application key created by an admin with
no applied scopes. **Grok parsing rules may effect JSON output and
require returned data to be configured before using in a request.** For
example, if you are using the data returned from a request for another
request body, and have a parsing rule that uses a regex pattern like `\s`
for spaces, you will need to configure all escaped spaces as `%{space}` to
use in the body data.
ration/pipelines). **Notes:** **Grok parsing rules may effect JSON
output and require returned data to be configured before using in a
request.** For example, if you are using the data returned from a request
for another request body, and have a parsing rule that uses a regex
pattern like `\s` for spaces, you will need to configure all escaped
spaces as `%{space}` to use in the body data.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
4 changes: 1 addition & 3 deletions tests/scenarios/features/v2/logs_archives.feature
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
Feature: Logs Archives
Archives forward all the logs ingested to a cloud storage system. See the
[Archives Page](https://app.datadoghq.com/logs/pipelines/archives) for a
list of the archives currently configured in Datadog. You need an API and
non-scoped application key with Admin rights to interact with these
endpoints.
list of the archives currently configured in Datadog.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
3 changes: 1 addition & 2 deletions tests/scenarios/features/v2/logs_metrics.feature
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
Feature: Logs Metrics
Manage configuration of [log-based
metrics](https://app.datadoghq.com/logs/pipelines/generate-metrics) for
your organization. You need an API and non-scoped application key with
Admin rights to interact with these endpoints.
your organization.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
Loading