Skip to content

(DOCS-7109) Update folder descriptions #1537

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

Merged
Merged
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": "2024-02-28 16:48:28.561191",
"spec_repo_commit": "9bc5f106"
"regenerated": "2024-02-28 18:48:42.808205",
"spec_repo_commit": "af330811"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-02-28 16:48:28.576750",
"spec_repo_commit": "9bc5f106"
"regenerated": "2024-02-28 18:48:42.825808",
"spec_repo_commit": "af330811"
}
}
}
10 changes: 6 additions & 4 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33819,6 +33819,7 @@ tags:
url: https://docs.datadoghq.com/account_management/api-app-keys/
name: Key Management
- 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/).

Expand Down Expand Up @@ -33849,7 +33850,8 @@ tags:
A graph can only contain a set number of points\nand as the timeframe over which
a metric is viewed increases,\naggregation between points occurs to stay below
that set number.\n\nThe Post, Patch, and Delete `manage_tags` API methods can
only be performed by\na user who has the `Manage Tags for Metrics` permission."
only be performed by\na user who has the `Manage Tags for Metrics` permission.\n\nSee
the [Metrics page](https://docs.datadoghq.com/metrics/) for more information."
name: Metrics
- description: '[Monitors](https://docs.datadoghq.com/monitors) allow you to watch
a metric or check that you care about and
Expand Down Expand Up @@ -33885,9 +33887,9 @@ tags:
externalDocs:
url: https://docs.datadoghq.com/integrations/pagerduty/
name: PagerDuty Integration
- description: 'Detection rules for generating signals and listing of generated

signals.'
- description: Create and manage your security rules, signals, filters, and more.
See the [Datadog Security page](https://docs.datadoghq.com/security/) for more
information.
name: Security Monitoring
- description: 'The service check endpoint allows you to post check statuses for use
with monitors.
Expand Down
43 changes: 27 additions & 16 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34617,7 +34617,8 @@ tags:

This is an enterprise-only feature. Request access by

contacting Datadog support.'
contacting Datadog support, or see the [IP Allowlist page](https://docs.datadoghq.com/account_management/org_settings/ip_allowlist/)
for more information.'
name: IP Allowlist
- description: Create, update, delete, and retrieve services which can be associated
with incidents. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/)
Expand All @@ -34643,13 +34644,14 @@ tags:
url: https://docs.datadoghq.com/account_management/api-app-keys/
name: Key Management
- 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: '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 web UI.'
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 @@ -34667,7 +34669,8 @@ tags:
points\nand as the timeframe over which a metric is viewed increases,\naggregation
between points occurs to stay below that set number.\n\nThe Post, Patch, and Delete
`manage_tags` API methods can only be performed by\na user who has the `Manage
Tags for Metrics` permission."
Tags for Metrics` permission.\n\nSee the [Metrics page](https://docs.datadoghq.com/metrics/)
for more information."
name: Metrics
- description: '[Monitors](https://docs.datadoghq.com/monitors) allow you to watch
a metric or check that you care about and
Expand All @@ -34683,8 +34686,8 @@ tags:
description: Find out more at
url: https://docs.datadoghq.com/monitors/create/types/
name: Monitors
- description: Configure your Datadog Okta integration directly through the Datadog
API.
- description: Configure your [Datadog Okta integration](https://docs.datadoghq.com/integrations/okta/)
directly through the Datadog API.
name: Okta Integration
- description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/)

Expand All @@ -34698,25 +34701,33 @@ tags:
description: Find out more at
url: https://docs.datadoghq.com/account_management/multi_organization
name: Organizations
- description: 'The powerpack endpoints allow you to:
- description: 'The Powerpack endpoints allow you to:


- Get a Powerpack

- Get a powerpack
- Create a Powerpack

- Create a powerpack
- Delete a Powerpack

- Delete a powerpack
- Get a list of all Powerpacks

- Get a list of all powerpacks

The Patch and Delete API methods can only be performed on a Powerpack by

The Patch and Delete API methods can only be performed on a powerpack by
a user who has the powerpack create permission for that specific Powerpack.

a user who has the powerpack create permission for that specific powerpack.'

Read [Scale Graphing Expertise with Powerpacks](https://docs.datadoghq.com/dashboards/guide/powerpacks-best-practices/)
for more information.'
name: Powerpack
- description: The processes API allows you to query processes data for your organization.
See the [Live Processes page](https://docs.datadoghq.com/infrastructure/process/)
for more information.
name: Processes
- description: Search or aggregate your RUM events over HTTP.
- description: Manage your Real User Monitoring (RUM) applications, and search or
aggregate your RUM events over HTTP. See the [RUM & Session Replay page](https://docs.datadoghq.com/real_user_monitoring/)
for more information
name: RUM
- description: 'A restriction policy defines the access control rules for a resource,
mapping a set of relations
Expand All @@ -34742,9 +34753,9 @@ tags:

[Pipelines page](https://app.datadoghq.com/logs/pipelines).'
name: Roles
- description: 'Detection rules for generating signals and listing of generated

signals.'
- description: Create and manage your security rules, signals, filters, and more.
See the [Datadog Security page](https://docs.datadoghq.com/security/) for more
information.
name: Security Monitoring
- description: Create, update, delete, and retrieve sensitive data scanner groups
and rules.
Expand Down
4 changes: 3 additions & 1 deletion features/v1/logs.feature
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
@endpoint(logs) @endpoint(logs-v1)
Feature: Logs
Search your logs and send them to your Datadog platform over HTTP.
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.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
3 changes: 2 additions & 1 deletion features/v1/metrics.feature
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ Feature: Metrics
timeframe over which a metric is viewed increases, aggregation between
points occurs to stay below that set number. The Post, Patch, and Delete
`manage_tags` API methods can only be performed by a user who has the
`Manage Tags for Metrics` permission.
`Manage Tags for Metrics` permission. See the [Metrics
page](https://docs.datadoghq.com/metrics/) for more information.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
4 changes: 3 additions & 1 deletion features/v1/security_monitoring.feature
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
@endpoint(security-monitoring) @endpoint(security-monitoring-v1)
Feature: Security Monitoring
Detection rules for generating signals and listing of generated signals.
Create and manage your security rules, signals, filters, and more. See the
[Datadog Security page](https://docs.datadoghq.com/security/) for more
information.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
4 changes: 3 additions & 1 deletion features/v2/ip_allowlist.feature
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ Feature: IP Allowlist
The IP allowlist API is used to manage the IP addresses that can access
the Datadog API and web UI. It does not block access to intake APIs or
public dashboards. This is an enterprise-only feature. Request access by
contacting Datadog support.
contacting Datadog support, or see the [IP Allowlist page](https://docs.da
tadoghq.com/account_management/org_settings/ip_allowlist/) for more
information.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
4 changes: 3 additions & 1 deletion features/v2/logs.feature
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
@endpoint(logs) @endpoint(logs-v2)
Feature: Logs
Search your logs and send them to your Datadog platform over HTTP.
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.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
2 changes: 1 addition & 1 deletion features/v2/logs_archives.feature
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +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 web UI.
list of the archives currently configured in Datadog.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
4 changes: 3 additions & 1 deletion features/v2/metrics.feature
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ Feature: Metrics
number of points and as the timeframe over which a metric is viewed
increases, aggregation between points occurs to stay below that set
number. The Post, Patch, and Delete `manage_tags` API methods can only be
performed by a user who has the `Manage Tags for Metrics` permission.
performed by a user who has the `Manage Tags for Metrics` permission. See
the [Metrics page](https://docs.datadoghq.com/metrics/) for more
information.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
4 changes: 3 additions & 1 deletion features/v2/okta_integration.feature
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
@endpoint(okta-integration) @endpoint(okta-integration-v2)
Feature: Okta Integration
Configure your Datadog Okta integration directly through the Datadog API.
Configure your [Datadog Okta
integration](https://docs.datadoghq.com/integrations/okta/) directly
through the Datadog API.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
11 changes: 7 additions & 4 deletions features/v2/powerpack.feature
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
@endpoint(powerpack) @endpoint(powerpack-v2)
Feature: Powerpack
The powerpack endpoints allow you to: - Get a powerpack - Create a
powerpack - Delete a powerpack - Get a list of all powerpacks The Patch
and Delete API methods can only be performed on a powerpack by a user who
has the powerpack create permission for that specific powerpack.
The Powerpack endpoints allow you to: - Get a Powerpack - Create a
Powerpack - Delete a Powerpack - Get a list of all Powerpacks The Patch
and Delete API methods can only be performed on a Powerpack by a user who
has the powerpack create permission for that specific Powerpack. Read
[Scale Graphing Expertise with
Powerpacks](https://docs.datadoghq.com/dashboards/guide/powerpacks-best-
practices/) for more information.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
4 changes: 3 additions & 1 deletion features/v2/processes.feature
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
@endpoint(processes) @endpoint(processes-v2)
Feature: Processes
The processes API allows you to query processes data for your
organization.
organization. See the [Live Processes
page](https://docs.datadoghq.com/infrastructure/process/) for more
information.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
5 changes: 4 additions & 1 deletion features/v2/rum.feature
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
@endpoint(rum) @endpoint(rum-v2)
Feature: RUM
Search or aggregate your RUM events over HTTP.
Manage your Real User Monitoring (RUM) applications, and search or
aggregate your RUM events over HTTP. See the [RUM & Session Replay
page](https://docs.datadoghq.com/real_user_monitoring/) for more
information

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
4 changes: 3 additions & 1 deletion features/v2/security_monitoring.feature
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
@endpoint(security-monitoring) @endpoint(security-monitoring-v2)
Feature: Security Monitoring
Detection rules for generating signals and listing of generated signals.
Create and manage your security rules, signals, filters, and more. See the
[Datadog Security page](https://docs.datadoghq.com/security/) for more
information.

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