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.

Sign up for GitHub

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

Clarify need of non-scoped app keys for some log endpoints #2795

Merged
merged 1 commit into from
Nov 19, 2024
Merged

Clarify need of non-scoped app keys for some log endpoints #2795

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
View file
Open in desktop
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": "2024-11-18 20:16:49.196101",
"spec_repo_commit": "1939caa6"
"regenerated": "2024-11-19 18:07:21.953644",
"spec_repo_commit": "f858f395"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-11-18 20:16:49.214895",
"spec_repo_commit": "1939caa6"
"regenerated": "2024-11-19 18:07:21.972993",
"spec_repo_commit": "f858f395"
}
}
}
14 changes: 8 additions & 6 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36442,7 +36442,8 @@ tags:
name: Logs
- description: 'Manage configuration of [log indexes](https://docs.datadoghq.com/logs/indexes/).

You need an API and application key with Admin rights to interact with this endpoint.'
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/indexes/
Expand All @@ -36454,11 +36455,12 @@ tags:
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.\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."
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."
externalDocs:
description: Find out more at
url: https://docs.datadoghq.com/logs/log_configuration
Expand Down
11 changes: 9 additions & 2 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43830,7 +43830,11 @@ tags:

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

for a list of the archives currently configured in Datadog.'
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.'
externalDocs:
description: Find out more at
url: https://docs.datadoghq.com/logs/archives/
Expand All @@ -43849,8 +43853,11 @@ 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
3 changes: 2 additions & 1 deletion tests/scenarios/features/v1/logs_indexes.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
Feature: Logs Indexes
Manage configuration of [log
indexes](https://docs.datadoghq.com/logs/indexes/). You need an API and
application key with Admin rights to interact with this endpoint.
non-scoped application key with Admin rights to interact with these
endpoints.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
13 changes: 7 additions & 6 deletions tests/scenarios/features/v1/logs_pipelines.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,13 @@ Feature: Logs Pipelines
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.
**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.
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.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
4 changes: 3 additions & 1 deletion tests/scenarios/features/v2/logs_archives.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
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.
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.

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

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