Skip to content

Commit 7940251

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
and
ci.datadog-api-spec
authored
(DOCS-7109) Update folder descriptions (#1537)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
1 parent 71ac5a2 commit 7940251

15 files changed

+75
-39
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-02-28 16:48:28.561191",
8-
"spec_repo_commit": "9bc5f106"
7+
"regenerated": "2024-02-28 18:48:42.808205",
8+
"spec_repo_commit": "af330811"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-02-28 16:48:28.576750",
13-
"spec_repo_commit": "9bc5f106"
12+
"regenerated": "2024-02-28 18:48:42.825808",
13+
"spec_repo_commit": "af330811"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33819,6 +33819,7 @@ tags:
3381933819
url: https://docs.datadoghq.com/account_management/api-app-keys/
3382033820
name: Key Management
3382133821
- description: Search your logs and send them to your Datadog platform over HTTP.
33822+
See the [Log Management page](https://docs.datadoghq.com/logs/) for more information.
3382233823
name: Logs
3382333824
- description: 'Manage configuration of [log indexes](https://docs.datadoghq.com/logs/indexes/).
3382433825

@@ -33849,7 +33850,8 @@ tags:
3384933850
A graph can only contain a set number of points\nand as the timeframe over which
3385033851
a metric is viewed increases,\naggregation between points occurs to stay below
3385133852
that set number.\n\nThe Post, Patch, and Delete `manage_tags` API methods can
33852-
only be performed by\na user who has the `Manage Tags for Metrics` permission."
33853+
only be performed by\na user who has the `Manage Tags for Metrics` permission.\n\nSee
33854+
the [Metrics page](https://docs.datadoghq.com/metrics/) for more information."
3385333855
name: Metrics
3385433856
- description: '[Monitors](https://docs.datadoghq.com/monitors) allow you to watch
3385533857
a metric or check that you care about and
@@ -33885,9 +33887,9 @@ tags:
3388533887
externalDocs:
3388633888
url: https://docs.datadoghq.com/integrations/pagerduty/
3388733889
name: PagerDuty Integration
33888-
- description: 'Detection rules for generating signals and listing of generated
33889-
33890-
signals.'
33890+
- description: Create and manage your security rules, signals, filters, and more.
33891+
See the [Datadog Security page](https://docs.datadoghq.com/security/) for more
33892+
information.
3389133893
name: Security Monitoring
3389233894
- description: 'The service check endpoint allows you to post check statuses for use
3389333895
with monitors.

.generator/schemas/v2/openapi.yaml

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -34617,7 +34617,8 @@ tags:
3461734617

3461834618
This is an enterprise-only feature. Request access by
3461934619

34620-
contacting Datadog support.'
34620+
contacting Datadog support, or see the [IP Allowlist page](https://docs.datadoghq.com/account_management/org_settings/ip_allowlist/)
34621+
for more information.'
3462134622
name: IP Allowlist
3462234623
- description: Create, update, delete, and retrieve services which can be associated
3462334624
with incidents. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/)
@@ -34643,13 +34644,14 @@ tags:
3464334644
url: https://docs.datadoghq.com/account_management/api-app-keys/
3464434645
name: Key Management
3464534646
- description: Search your logs and send them to your Datadog platform over HTTP.
34647+
See the [Log Management page](https://docs.datadoghq.com/logs/) for more information.
3464634648
name: Logs
3464734649
- description: 'Archives forward all the logs ingested to a cloud storage system.
3464834650

3464934651

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

34652-
for a list of the archives currently configured in web UI.'
34654+
for a list of the archives currently configured in Datadog.'
3465334655
externalDocs:
3465434656
description: Find out more at
3465534657
url: https://docs.datadoghq.com/logs/archives/
@@ -34667,7 +34669,8 @@ tags:
3466734669
points\nand as the timeframe over which a metric is viewed increases,\naggregation
3466834670
between points occurs to stay below that set number.\n\nThe Post, Patch, and Delete
3466934671
`manage_tags` API methods can only be performed by\na user who has the `Manage
34670-
Tags for Metrics` permission."
34672+
Tags for Metrics` permission.\n\nSee the [Metrics page](https://docs.datadoghq.com/metrics/)
34673+
for more information."
3467134674
name: Metrics
3467234675
- description: '[Monitors](https://docs.datadoghq.com/monitors) allow you to watch
3467334676
a metric or check that you care about and
@@ -34683,8 +34686,8 @@ tags:
3468334686
description: Find out more at
3468434687
url: https://docs.datadoghq.com/monitors/create/types/
3468534688
name: Monitors
34686-
- description: Configure your Datadog Okta integration directly through the Datadog
34687-
API.
34689+
- description: Configure your [Datadog Okta integration](https://docs.datadoghq.com/integrations/okta/)
34690+
directly through the Datadog API.
3468834691
name: Okta Integration
3468934692
- description: 'Configure your [Datadog Opsgenie integration](https://docs.datadoghq.com/integrations/opsgenie/)
3469034693

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

34707+
- Get a Powerpack
3470334708

34704-
- Get a powerpack
34709+
- Create a Powerpack
3470534710

34706-
- Create a powerpack
34711+
- Delete a Powerpack
3470734712

34708-
- Delete a powerpack
34713+
- Get a list of all Powerpacks
3470934714

34710-
- Get a list of all powerpacks
3471134715

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

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

34715-
a user who has the powerpack create permission for that specific powerpack.'
34720+
34721+
Read [Scale Graphing Expertise with Powerpacks](https://docs.datadoghq.com/dashboards/guide/powerpacks-best-practices/)
34722+
for more information.'
3471634723
name: Powerpack
3471734724
- description: The processes API allows you to query processes data for your organization.
34725+
See the [Live Processes page](https://docs.datadoghq.com/infrastructure/process/)
34726+
for more information.
3471834727
name: Processes
34719-
- description: Search or aggregate your RUM events over HTTP.
34728+
- description: Manage your Real User Monitoring (RUM) applications, and search or
34729+
aggregate your RUM events over HTTP. See the [RUM & Session Replay page](https://docs.datadoghq.com/real_user_monitoring/)
34730+
for more information
3472034731
name: RUM
3472134732
- description: 'A restriction policy defines the access control rules for a resource,
3472234733
mapping a set of relations
@@ -34742,9 +34753,9 @@ tags:
3474234753

3474334754
[Pipelines page](https://app.datadoghq.com/logs/pipelines).'
3474434755
name: Roles
34745-
- description: 'Detection rules for generating signals and listing of generated
34746-
34747-
signals.'
34756+
- description: Create and manage your security rules, signals, filters, and more.
34757+
See the [Datadog Security page](https://docs.datadoghq.com/security/) for more
34758+
information.
3474834759
name: Security Monitoring
3474934760
- description: Create, update, delete, and retrieve sensitive data scanner groups
3475034761
and rules.

features/v1/logs.feature

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
@endpoint(logs) @endpoint(logs-v1)
22
Feature: Logs
3-
Search your logs and send them to your Datadog platform over HTTP.
3+
Search your logs and send them to your Datadog platform over HTTP. See the
4+
[Log Management page](https://docs.datadoghq.com/logs/) for more
5+
information.
46

57
Background:
68
Given a valid "apiKeyAuth" key in the system

features/v1/metrics.feature

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ Feature: Metrics
77
timeframe over which a metric is viewed increases, aggregation between
88
points occurs to stay below that set number. The Post, Patch, and Delete
99
`manage_tags` API methods can only be performed by a user who has the
10-
`Manage Tags for Metrics` permission.
10+
`Manage Tags for Metrics` permission. See the [Metrics
11+
page](https://docs.datadoghq.com/metrics/) for more information.
1112

1213
Background:
1314
Given a valid "apiKeyAuth" key in the system

features/v1/security_monitoring.feature

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
@endpoint(security-monitoring) @endpoint(security-monitoring-v1)
22
Feature: Security Monitoring
3-
Detection rules for generating signals and listing of generated signals.
3+
Create and manage your security rules, signals, filters, and more. See the
4+
[Datadog Security page](https://docs.datadoghq.com/security/) for more
5+
information.
46

57
Background:
68
Given a valid "apiKeyAuth" key in the system

features/v2/ip_allowlist.feature

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ Feature: IP Allowlist
33
The IP allowlist API is used to manage the IP addresses that can access
44
the Datadog API and web UI. It does not block access to intake APIs or
55
public dashboards. This is an enterprise-only feature. Request access by
6-
contacting Datadog support.
6+
contacting Datadog support, or see the [IP Allowlist page](https://docs.da
7+
tadoghq.com/account_management/org_settings/ip_allowlist/) for more
8+
information.
79

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

features/v2/logs.feature

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
@endpoint(logs) @endpoint(logs-v2)
22
Feature: Logs
3-
Search your logs and send them to your Datadog platform over HTTP.
3+
Search your logs and send them to your Datadog platform over HTTP. See the
4+
[Log Management page](https://docs.datadoghq.com/logs/) for more
5+
information.
46

57
Background:
68
Given a valid "apiKeyAuth" key in the system

features/v2/logs_archives.feature

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +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 web UI.
5+
list of the archives currently configured in Datadog.
66

77
Background:
88
Given a valid "apiKeyAuth" key in the system

features/v2/metrics.feature

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ Feature: Metrics
77
number of points and as the timeframe over which a metric is viewed
88
increases, aggregation between points occurs to stay below that set
99
number. The Post, Patch, and Delete `manage_tags` API methods can only be
10-
performed by a user who has the `Manage Tags for Metrics` permission.
10+
performed by a user who has the `Manage Tags for Metrics` permission. See
11+
the [Metrics page](https://docs.datadoghq.com/metrics/) for more
12+
information.
1113

1214
Background:
1315
Given a valid "apiKeyAuth" key in the system

features/v2/okta_integration.feature

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
@endpoint(okta-integration) @endpoint(okta-integration-v2)
22
Feature: Okta Integration
3-
Configure your Datadog Okta integration directly through the Datadog API.
3+
Configure your [Datadog Okta
4+
integration](https://docs.datadoghq.com/integrations/okta/) directly
5+
through the Datadog API.
46

57
Background:
68
Given a valid "apiKeyAuth" key in the system

features/v2/powerpack.feature

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
@endpoint(powerpack) @endpoint(powerpack-v2)
22
Feature: Powerpack
3-
The powerpack endpoints allow you to: - Get a powerpack - Create a
4-
powerpack - Delete a powerpack - Get a list of all powerpacks The Patch
5-
and Delete API methods can only be performed on a powerpack by a user who
6-
has the powerpack create permission for that specific powerpack.
3+
The Powerpack endpoints allow you to: - Get a Powerpack - Create a
4+
Powerpack - Delete a Powerpack - Get a list of all Powerpacks The Patch
5+
and Delete API methods can only be performed on a Powerpack by a user who
6+
has the powerpack create permission for that specific Powerpack. Read
7+
[Scale Graphing Expertise with
8+
Powerpacks](https://docs.datadoghq.com/dashboards/guide/powerpacks-best-
9+
practices/) for more information.
710

811
Background:
912
Given a valid "apiKeyAuth" key in the system

features/v2/processes.feature

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
@endpoint(processes) @endpoint(processes-v2)
22
Feature: Processes
33
The processes API allows you to query processes data for your
4-
organization.
4+
organization. See the [Live Processes
5+
page](https://docs.datadoghq.com/infrastructure/process/) for more
6+
information.
57

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

features/v2/rum.feature

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
@endpoint(rum) @endpoint(rum-v2)
22
Feature: RUM
3-
Search or aggregate your RUM events over HTTP.
3+
Manage your Real User Monitoring (RUM) applications, and search or
4+
aggregate your RUM events over HTTP. See the [RUM & Session Replay
5+
page](https://docs.datadoghq.com/real_user_monitoring/) for more
6+
information
47

58
Background:
69
Given a valid "apiKeyAuth" key in the system

features/v2/security_monitoring.feature

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
@endpoint(security-monitoring) @endpoint(security-monitoring-v2)
22
Feature: Security Monitoring
3-
Detection rules for generating signals and listing of generated signals.
3+
Create and manage your security rules, signals, filters, and more. See the
4+
[Datadog Security page](https://docs.datadoghq.com/security/) for more
5+
information.
46

57
Background:
68
Given a valid "apiKeyAuth" key in the system

0 commit comments

Comments
 (0)