Skip to content

Commit 7d49150

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

12 files changed

+55
-40
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 18:48:42.808205",
8-
"spec_repo_commit": "af330811"
7+
"regenerated": "2024-02-28 20:18:56.052368",
8+
"spec_repo_commit": "a9aecd28"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-02-28 18:48:42.825808",
13-
"spec_repo_commit": "af330811"
12+
"regenerated": "2024-02-28 20:18:56.113404",
13+
"spec_repo_commit": "a9aecd28"
1414
}
1515
}
1616
}

‎.generator/schemas/v1/openapi.yaml

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33906,18 +33906,18 @@ tags:
3390633906
an OK status.
3390733907

3390833908

33909-
- [Read more about Service Check monitors.][1]
33909+
- [Read more about Service Check monitors][1].
3391033910

33911-
- [Read more about Process Check monitors.][2]
33911+
- [Read more about Process Check monitors][2].
3391233912

33913-
- [Read more about Network Check monitors.][3]
33913+
- [Read more about Network monitors][3].
3391433914

33915-
- [Read more about Custom Check monitors.][4]
33915+
- [Read more about Custom Check monitors][4].
3391633916

33917-
- [Read more about Service Check and status codes.][5]
33917+
- [Read more about Service Checks and status codes][5].
3391833918

3391933919

33920-
[1]: https://docs.datadoghq.com/monitors/create/types/host/?tab=checkalert
33920+
[1]: https://docs.datadoghq.com/monitors/types/service_check/
3392133921

3392233922
[2]: https://docs.datadoghq.com/monitors/create/types/process_check/?tab=checkalert
3392333923

@@ -33931,7 +33931,8 @@ tags:
3393133931
from negatively impacting\nyour SLO\u2019s status and error budget. You can use
3393233932
Status Corrections for various purposes, such\nas removing planned maintenance
3393333933
windows, non-business hours, or other time periods that do\nnot correspond to
33934-
genuine issues."
33934+
genuine issues. See [SLO status corrections](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-status-corrections)
33935+
for more information."
3393533936
name: Service Level Objective Corrections
3393633937
- description: '[Service Level Objectives](https://docs.datadoghq.com/monitors/service_level_objectives/#configuration)
3393733938

@@ -33981,9 +33982,7 @@ tags:
3398133982
users, feed, chef, puppet, git, bitbucket, fabric, capistrano, etc.
3398233983

3398333984

33984-
Read more about tags on the dedicated
33985-
33986-
[documentation page](https://docs.datadoghq.com/tagging).'
33985+
Read more about tags on [Getting Started with Tags](https://docs.datadoghq.com/getting_started/tagging/).'
3398733986
name: Tags
3398833987
- description: 'The usage metering API allows you to get hourly, daily, and
3398933988

@@ -34015,9 +34014,8 @@ tags:
3401534014
- description: 'Configure your Datadog-Webhooks integration directly through the Datadog
3401634015
API.
3401734016

34018-
For more information about the Datadog-Webhooks integration,
34019-
34020-
see the [integration page](https://docs.datadoghq.com/integrations/webhooks).'
34017+
See the [Webhooks integration page](https://docs.datadoghq.com/integrations/webhooks)
34018+
for more information.'
3402134019
externalDocs:
3402234020
url: https://docs.datadoghq.com/integrations/webhooks
3402334021
name: Webhooks Integration

‎.generator/schemas/v2/openapi.yaml

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34758,15 +34758,19 @@ tags:
3475834758
information.
3475934759
name: Security Monitoring
3476034760
- description: Create, update, delete, and retrieve sensitive data scanner groups
34761-
and rules.
34761+
and rules. See the [Sensitive Data Scanner page](https://docs.datadoghq.com/sensitive_data_scanner/)
34762+
for more information.
3476234763
name: Sensitive Data Scanner
34763-
- description: Create, edit, and disable service accounts.
34764+
- description: Create, edit, and disable service accounts. See the [Service Accounts
34765+
page](https://docs.datadoghq.com/account_management/org_settings/service_accounts/)
34766+
for more information.
3476434767
name: Service Accounts
3476534768
- description: API to create, update, retrieve and delete service definitions.
3476634769
externalDocs:
3476734770
url: https://docs.datadoghq.com/tracing/service_catalog/
3476834771
name: Service Definition
34769-
- description: 'API to create, update scorecard rules and outcomes.
34772+
- description: 'API to create, update scorecard rules and outcomes. See [Service Scorecards](https://docs.datadoghq.com/account_management/org_settings/service_accounts/)
34773+
for more information.
3477034774

3477134775

3477234776
This feature is currently in BETA. If you have any feedback, contact [Datadog
@@ -34775,7 +34779,8 @@ tags:
3477534779
- description: Search and aggregate your spans from your Datadog platform over HTTP.
3477634780
name: Spans
3477734781
- description: Manage configuration of [span-based metrics](https://app.datadoghq.com/apm/traces/generate-metrics)
34778-
for your organization.
34782+
for your organization. See [Generate Metrics from Spans](https://docs.datadoghq.com/tracing/trace_pipeline/generate_metrics/)
34783+
for more information.
3477934784
externalDocs:
3478034785
description: Find out more at
3478134786
url: https://docs.datadoghq.com/tracing/metrics/metrics_namespace/
@@ -34787,7 +34792,8 @@ tags:
3478734792
use Datadog\u2019s API to\nmanage both test types programmatically.\n\nFor more
3478834793
information about Synthetics, see the [Synthetics overview](https://docs.datadoghq.com/synthetics/)."
3478934794
name: Synthetics
34790-
- description: View and manage teams within Datadog.
34795+
- description: View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/)
34796+
for more information.
3479134797
name: Teams
3479234798
- description: 'The usage metering API allows you to get hourly, daily, and
3479334799

‎features/v1/service_checks.feature

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,12 @@ Feature: Service Checks
55
is posted with a message containing more than 500 characters, only the
66
first 500 characters are displayed. Messages are limited for checks with a
77
Critical or Warning status, they are dropped for checks with an OK status.
8-
- [Read more about Service Check monitors.][1] - [Read more about Process
9-
Check monitors.][2] - [Read more about Network Check monitors.][3] - [Read
10-
more about Custom Check monitors.][4] - [Read more about Service Check and
11-
status codes.][5] [1]:
12-
https://docs.datadoghq.com/monitors/create/types/host/?tab=checkalert [2]:
13-
https://docs.datadoghq.com/monitors/create/types/process_check/?tab=checka
14-
lert [3]:
8+
- [Read more about Service Check monitors][1]. - [Read more about Process
9+
Check monitors][2]. - [Read more about Network monitors][3]. - [Read more
10+
about Custom Check monitors][4]. - [Read more about Service Checks and
11+
status codes][5]. [1]:
12+
https://docs.datadoghq.com/monitors/types/service_check/ [2]: https://docs
13+
.datadoghq.com/monitors/create/types/process_check/?tab=checkalert [3]:
1514
https://docs.datadoghq.com/monitors/create/types/network/?tab=checkalert
1615
[4]: https://docs.datadoghq.com/monitors/create/types/custom_check/?tab=ch
1716
eckalert [5]: https://docs.datadoghq.com/developers/service_checks/

‎features/v1/service_level_objective_corrections.feature

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ Feature: Service Level Objective Corrections
44
negatively impacting your SLO’s status and error budget. You can use
55
Status Corrections for various purposes, such as removing planned
66
maintenance windows, non-business hours, or other time periods that do not
7-
correspond to genuine issues.
7+
correspond to genuine issues. See [SLO status corrections](https://docs.da
8+
tadoghq.com/service_management/service_level_objectives/#slo-status-
9+
corrections) for more information.
810

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

‎features/v1/tags.feature

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Feature: Tags
66
tags to a particular host. The component of your infrastructure
77
responsible for a tag is identified by a source. For example, some valid
88
sources include nagios, hudson, jenkins, users, feed, chef, puppet, git,
9-
bitbucket, fabric, capistrano, etc. Read more about tags on the dedicated
10-
[documentation page](https://docs.datadoghq.com/tagging).
9+
bitbucket, fabric, capistrano, etc. Read more about tags on [Getting
10+
Started with Tags](https://docs.datadoghq.com/getting_started/tagging/).
1111

1212
Background:
1313
Given a valid "apiKeyAuth" key in the system

‎features/v1/webhooks_integration.feature

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
@endpoint(webhooks-integration) @endpoint(webhooks-integration-v1)
22
Feature: Webhooks Integration
33
Configure your Datadog-Webhooks integration directly through the Datadog
4-
API. For more information about the Datadog-Webhooks integration, see the
5-
[integration page](https://docs.datadoghq.com/integrations/webhooks).
4+
API. See the [Webhooks integration
5+
page](https://docs.datadoghq.com/integrations/webhooks) for more
6+
information.
67

78
Background:
89
Given a valid "apiKeyAuth" key in the system

‎features/v2/sensitive_data_scanner.feature

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
@endpoint(sensitive-data-scanner) @endpoint(sensitive-data-scanner-v2) @endpoint(sensitivedatascanner) @endpoint(sensitivedatascanner-v2)
22
Feature: Sensitive Data Scanner
33
Create, update, delete, and retrieve sensitive data scanner groups and
4-
rules.
4+
rules. See the [Sensitive Data Scanner
5+
page](https://docs.datadoghq.com/sensitive_data_scanner/) for more
6+
information.
57

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

‎features/v2/service_accounts.feature

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
@endpoint(service-accounts) @endpoint(service-accounts-v2)
22
Feature: Service Accounts
3-
Create, edit, and disable service accounts.
3+
Create, edit, and disable service accounts. See the [Service Accounts page
4+
](https://docs.datadoghq.com/account_management/org_settings/service_accou
5+
nts/) for more information.
46

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

‎features/v2/service_scorecards.feature

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
@endpoint(service-scorecards) @endpoint(service-scorecards-v2)
22
Feature: Service Scorecards
3-
API to create, update scorecard rules and outcomes. This feature is
4-
currently in BETA. If you have any feedback, contact [Datadog
3+
API to create, update scorecard rules and outcomes. See [Service Scorecard
4+
s](https://docs.datadoghq.com/account_management/org_settings/service_acco
5+
unts/) for more information. This feature is currently in BETA. If you
6+
have any feedback, contact [Datadog
57
support](https://docs.datadoghq.com/help/).
68

79
Background:

0 commit comments

Comments
 (0)