Skip to content

Commit

Permalink
Update tag descriptions (#1857)
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
api-clients-generation-pipeline[bot] and ci.datadog-api-spec committed Feb 5, 2024
1 parent 5d3e96a commit 2b282ba
Show file tree
Hide file tree
Showing 23 changed files with 78 additions and 69 deletions.
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-01-31 20:51:09.699607",
"spec_repo_commit": "e545b10b"
"regenerated": "2024-02-05 19:51:56.938870",
"spec_repo_commit": "4e68d2cd"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-01-31 20:51:09.736111",
"spec_repo_commit": "e545b10b"
"regenerated": "2024-02-05 19:51:56.952999",
"spec_repo_commit": "4e68d2cd"
}
}
}
23 changes: 10 additions & 13 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33601,10 +33601,9 @@ tags:
organization.'
name: Dashboard Lists
x-deprecated: true
- description: 'Interact with your dashboard lists through the API to make it easier
to organize,

find, and share all of your dashboards with your team and organization.'
- description: Manage all your dashboards, as well as access to your shared dashboards,
through the API. See the [Dashboards page](https://docs.datadoghq.com/dashboards/)
for more information.
name: Dashboards
- description: '[Downtiming](https://docs.datadoghq.com/monitors/notify/downtimes)
gives
Expand All @@ -33615,23 +33614,21 @@ tags:

end times, prevent all alerting related to specified Datadog tags.'
name: Downtimes
- description: 'The events service allows you to programmatically post events to the
event stream

and fetch events from the event stream. Events are limited to 4000 characters.

If an event is sent out with a message containing more than 4000 characters, only
the
- description: 'The Event Management API allows you to programmatically post events
to the Events Explorer

first 4000 characters are displayed.'
and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/)
for more information.'
name: Events
- description: 'Configure your Datadog-Google Cloud Platform (GCP) integration directly

through the Datadog API. Read more about the [Datadog-Google Cloud Platform integration](https://docs.datadoghq.com/integrations/google_cloud_platform).'
externalDocs:
url: https://docs.datadoghq.com/integrations/google_cloud_platform
name: GCP Integration
- description: Get information about your live hosts in Datadog.
- description: Get information about your infrastructure hosts in Datadog, and mute
or unmute any notifications from your hosts. See the [Infrastructure page](https://docs.datadoghq.com/infrastructure/)
for more information.
name: Hosts
- description: Get a list of IP prefixes belonging to Datadog.
name: IP Ranges
Expand Down
34 changes: 19 additions & 15 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33475,13 +33475,17 @@ tags:
API. See the [Cloudflare integration page](https://docs.datadoghq.com/integrations/cloudflare/)
for more information.
name: Cloudflare Integration
- description: Configure your Datadog Confluent Cloud integration directly through
the Datadog API.
- description: Manage your Datadog Confluent Cloud integration accounts and account
resources directly through the Datadog API. See the [Confluent Cloud page](https://docs.datadoghq.com/integrations/confluent_cloud/)
for more information.
name: Confluent Cloud
- description: The Container Images API allows you to query Container Image data for
your organization.
your organization. See the [Container Images View page](https://docs.datadoghq.com/infrastructure/containers/container_images/)
for more information.
name: Container Images
- description: The Containers API allows you to query container data for your organization.
See the [Container Monitoring page](https://docs.datadoghq.com/containers/) for
more information.
name: Containers
- description: Send events for DORA Metrics to measure and improve software delivery.
See the [DORA Metrics page](https://docs.datadoghq.com/dora_metrics/) for more
Expand All @@ -33505,18 +33509,15 @@ tags:

end times, prevent all alerting related to specified Datadog tags.'
name: Downtimes
- description: 'The events service allows you to programmatically post events to the
event stream

and fetch events from the event stream. Events are limited to 4000 characters.

If an event is sent out with a message containing more than 4000 characters, only
the
- description: 'The Event Management API allows you to programmatically post events
to the Events Explorer

first 4000 characters are displayed.'
and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/)
for more information.'
name: Events
- description: Configure your Datadog Fastly integration directly through the Datadog
API.
- description: Manage your Datadog Fastly integration accounts and services directly
through the Datadog API. See the [Fastly integration page](https://docs.datadoghq.com/integrations/fastly/)
for more information.
name: Fastly Integration
- description: 'Configure your Datadog-Google Cloud Platform (GCP) integration directly

Expand All @@ -33536,12 +33537,15 @@ tags:
contacting Datadog support.'
name: IP Allowlist
- description: Create, update, delete, and retrieve services which can be associated
with incidents.
with incidents. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/)
for more information.
name: Incident Services
- description: The Incident Teams endpoints are deprecated. See the [Teams API endpoints](https://docs.datadoghq.com/api/latest/teams/)
to create, update, delete, and retrieve teams which can be associated with incidents.
name: Incident Teams
- description: Manage incident response.
- description: Manage incident response, as well as associated attachments, metadata,
and todos. See the [Incident Management page](https://docs.datadoghq.com/service_management/incident_management/)
for more information.
name: Incidents
- description: 'Manage your Datadog API and application keys. You need an API key
and
Expand Down
3 changes: 1 addition & 2 deletions src/datadog_api_client/v1/api/dashboards_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@

class DashboardsApi:
"""
Interact with your dashboard lists through the API to make it easier to organize,
find, and share all of your dashboards with your team and organization.
Manage all your dashboards, as well as access to your shared dashboards, through the API. See the `Dashboards page <https://docs.datadoghq.com/dashboards/>`_ for more information.
"""

def __init__(self, api_client=None):
Expand Down
6 changes: 2 additions & 4 deletions src/datadog_api_client/v1/api/events_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,8 @@

class EventsApi:
"""
The events service allows you to programmatically post events to the event stream
and fetch events from the event stream. Events are limited to 4000 characters.
If an event is sent out with a message containing more than 4000 characters, only the
first 4000 characters are displayed.
The Event Management API allows you to programmatically post events to the Events Explorer
and fetch events from the Events Explorer. See the `Event Management page <https://docs.datadoghq.com/service_management/events/>`_ for more information.
"""

def __init__(self, api_client=None):
Expand Down
2 changes: 1 addition & 1 deletion src/datadog_api_client/v1/api/hosts_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

class HostsApi:
"""
Get information about your live hosts in Datadog.
Get information about your infrastructure hosts in Datadog, and mute or unmute any notifications from your hosts. See the `Infrastructure page <https://docs.datadoghq.com/infrastructure/>`_ for more information.
"""

def __init__(self, api_client=None):
Expand Down
2 changes: 1 addition & 1 deletion src/datadog_api_client/v2/api/confluent_cloud_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

class ConfluentCloudApi:
"""
Configure your Datadog Confluent Cloud integration directly through the Datadog API.
Manage your Datadog Confluent Cloud integration accounts and account resources directly through the Datadog API. See the `Confluent Cloud page <https://docs.datadoghq.com/integrations/confluent_cloud/>`_ for more information.
"""

def __init__(self, api_client=None):
Expand Down
2 changes: 1 addition & 1 deletion src/datadog_api_client/v2/api/container_images_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

class ContainerImagesApi:
"""
The Container Images API allows you to query Container Image data for your organization.
The Container Images API allows you to query Container Image data for your organization. See the `Container Images View page <https://docs.datadoghq.com/infrastructure/containers/container_images/>`_ for more information.
"""

def __init__(self, api_client=None):
Expand Down
2 changes: 1 addition & 1 deletion src/datadog_api_client/v2/api/containers_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

class ContainersApi:
"""
The Containers API allows you to query container data for your organization.
The Containers API allows you to query container data for your organization. See the `Container Monitoring page <https://docs.datadoghq.com/containers/>`_ for more information.
"""

def __init__(self, api_client=None):
Expand Down
6 changes: 2 additions & 4 deletions src/datadog_api_client/v2/api/events_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,8 @@

class EventsApi:
"""
The events service allows you to programmatically post events to the event stream
and fetch events from the event stream. Events are limited to 4000 characters.
If an event is sent out with a message containing more than 4000 characters, only the
first 4000 characters are displayed.
The Event Management API allows you to programmatically post events to the Events Explorer
and fetch events from the Events Explorer. See the `Event Management page <https://docs.datadoghq.com/service_management/events/>`_ for more information.
"""

def __init__(self, api_client=None):
Expand Down
2 changes: 1 addition & 1 deletion src/datadog_api_client/v2/api/fastly_integration_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

class FastlyIntegrationApi:
"""
Configure your Datadog Fastly integration directly through the Datadog API.
Manage your Datadog Fastly integration accounts and services directly through the Datadog API. See the `Fastly integration page <https://docs.datadoghq.com/integrations/fastly/>`_ for more information.
"""

def __init__(self, api_client=None):
Expand Down
2 changes: 1 addition & 1 deletion src/datadog_api_client/v2/api/incident_services_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

class IncidentServicesApi:
"""
Create, update, delete, and retrieve services which can be associated with incidents.
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/>`_ for more information.
"""

def __init__(self, api_client=None):
Expand Down
2 changes: 1 addition & 1 deletion src/datadog_api_client/v2/api/incidents_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@

class IncidentsApi:
"""
Manage incident response.
Manage incident response, as well as associated attachments, metadata, and todos. See the `Incident Management page <https://docs.datadoghq.com/service_management/incident_management/>`_ for more information.
"""

def __init__(self, api_client=None):
Expand Down
6 changes: 3 additions & 3 deletions tests/v1/features/dashboards.feature
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
@endpoint(dashboards) @endpoint(dashboards-v1)
Feature: Dashboards
Interact with your dashboard lists through the API to make it easier to
organize, find, and share all of your dashboards with your team and
organization.
Manage all your dashboards, as well as access to your shared dashboards,
through the API. See the [Dashboards
page](https://docs.datadoghq.com/dashboards/) for more information.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
8 changes: 4 additions & 4 deletions tests/v1/features/events.feature
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
@endpoint(events) @endpoint(events-v1)
Feature: Events
The events service allows you to programmatically post events to the event
stream and fetch events from the event stream. Events are limited to 4000
characters. If an event is sent out with a message containing more than
4000 characters, only the first 4000 characters are displayed.
The Event Management API allows you to programmatically post events to the
Events Explorer and fetch events from the Events Explorer. See the [Event
Management page](https://docs.datadoghq.com/service_management/events/)
for more information.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
4 changes: 3 additions & 1 deletion tests/v1/features/hosts.feature
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
@endpoint(hosts) @endpoint(hosts-v1)
Feature: Hosts
Get information about your live hosts in Datadog.
Get information about your infrastructure hosts in Datadog, and mute or
unmute any notifications from your hosts. See the [Infrastructure
page](https://docs.datadoghq.com/infrastructure/) for more information.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
6 changes: 4 additions & 2 deletions tests/v2/features/confluent_cloud.feature
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
@endpoint(confluent-cloud) @endpoint(confluent-cloud-v2)
Feature: Confluent Cloud
Configure your Datadog Confluent Cloud integration directly through the
Datadog API.
Manage your Datadog Confluent Cloud integration accounts and account
resources directly through the Datadog API. See the [Confluent Cloud
page](https://docs.datadoghq.com/integrations/confluent_cloud/) for more
information.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
3 changes: 2 additions & 1 deletion tests/v2/features/container_images.feature
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
@endpoint(container-images) @endpoint(container-images-v2)
Feature: Container Images
The Container Images API allows you to query Container Image data for your
organization.
organization. See the [Container Images View page](https://docs.datadoghq.
com/infrastructure/containers/container_images/) for more information.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
3 changes: 2 additions & 1 deletion tests/v2/features/containers.feature
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
@endpoint(containers) @endpoint(containers-v2)
Feature: Containers
The Containers API allows you to query container data for your
organization.
organization. See the [Container Monitoring
page](https://docs.datadoghq.com/containers/) for more information.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
8 changes: 4 additions & 4 deletions tests/v2/features/events.feature
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
@endpoint(events) @endpoint(events-v2)
Feature: Events
The events service allows you to programmatically post events to the event
stream and fetch events from the event stream. Events are limited to 4000
characters. If an event is sent out with a message containing more than
4000 characters, only the first 4000 characters are displayed.
The Event Management API allows you to programmatically post events to the
Events Explorer and fetch events from the Events Explorer. See the [Event
Management page](https://docs.datadoghq.com/service_management/events/)
for more information.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
6 changes: 4 additions & 2 deletions tests/v2/features/fastly_integration.feature
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
@endpoint(fastly-integration) @endpoint(fastly-integration-v2)
Feature: Fastly Integration
Configure your Datadog Fastly integration directly through the Datadog
API.
Manage your Datadog Fastly integration accounts and services directly
through the Datadog API. See the [Fastly integration
page](https://docs.datadoghq.com/integrations/fastly/) for more
information.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
4 changes: 3 additions & 1 deletion tests/v2/features/incident_services.feature
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
@endpoint(incident-services) @endpoint(incident-services-v2)
Feature: Incident Services
Create, update, delete, and retrieve services which can be associated with
incidents.
incidents. See the [Incident Management
page](https://docs.datadoghq.com/service_management/incident_management/)
for more information.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
5 changes: 4 additions & 1 deletion tests/v2/features/incidents.feature
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
@endpoint(incidents) @endpoint(incidents-v2)
Feature: Incidents
Manage incident response.
Manage incident response, as well as associated attachments, metadata, and
todos. See the [Incident Management
page](https://docs.datadoghq.com/service_management/incident_management/)
for more information.

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

0 comments on commit 2b282ba

Please sign in to comment.