Skip to content

[DOCS-10044] Fix outdated feature name in CI Visibility Tests API docs #2408

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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": "2025-02-12 18:33:47.788334",
"spec_repo_commit": "6a4cfb82"
"regenerated": "2025-02-13 17:04:01.282746",
"spec_repo_commit": "393eda14"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-02-12 18:33:47.802844",
"spec_repo_commit": "6a4cfb82"
"regenerated": "2025-02-13 17:04:01.301910",
"spec_repo_commit": "393eda14"
}
}
}
25 changes: 11 additions & 14 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3741,7 +3741,7 @@ components:
properties:
attributes:
additionalProperties: {}
description: JSON object of attributes from CI Visibility test events.
description: JSON object of attributes from Test Optimization test events.
example:
customAttribute: 123
duration: 2345
Expand Down Expand Up @@ -35086,8 +35086,8 @@ paths:
- ci_visibility_read
/api/v2/ci/tests/analytics/aggregate:
post:
description: The API endpoint to aggregate CI Visibility test events into buckets
of computed metrics and timeseries.
description: The API endpoint to aggregate test events into buckets of computed
metrics and timeseries.
operationId: AggregateCIAppTestEvents
requestBody:
content:
Expand Down Expand Up @@ -35115,16 +35115,15 @@ paths:
- ci_visibility_read
summary: Aggregate tests events
tags:
- CI Visibility Tests
- Test Optimization
x-codegen-request-body-name: body
x-permission:
operator: OR
permissions:
- ci_visibility_read
/api/v2/ci/tests/events:
get:
description: 'List endpoint returns CI Visibility test events that match a [search
query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
description: 'List endpoint returns test events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).

[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Expand Down Expand Up @@ -35199,7 +35198,7 @@ paths:
- ci_visibility_read
summary: Get a list of tests events
tags:
- CI Visibility Tests
- Test Optimization
x-pagination:
cursorParam: page[cursor]
cursorPath: meta.page.after
Expand All @@ -35211,8 +35210,7 @@ paths:
- ci_visibility_read
/api/v2/ci/tests/events/search:
post:
description: 'List endpoint returns CI Visibility test events that match a [search
query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).
description: 'List endpoint returns test events that match a [search query](https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/).

[Results are paginated similarly to logs](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination).

Expand Down Expand Up @@ -35245,7 +35243,7 @@ paths:
- ci_visibility_read
summary: Search tests events
tags:
- CI Visibility Tests
- Test Optimization
x-codegen-request-body-name: body
x-pagination:
cursorParam: body.page.cursor
Expand Down Expand Up @@ -51224,10 +51222,6 @@ tags:
to your Datadog site over HTTP. See the [CI Pipeline Visibility in Datadog page](https://docs.datadoghq.com/continuous_integration/pipelines/)
for more information.
name: CI Visibility Pipelines
- description: Search or aggregate your CI Visibility test events over HTTP. See the
[Test Visibility in Datadog page](https://docs.datadoghq.com/tests/) for more
information.
name: CI Visibility Tests
- description: 'Datadog Cloud Security Management (CSM) delivers real-time threat
detection

Expand Down Expand Up @@ -51574,6 +51568,9 @@ tags:
- description: View and manage teams within Datadog. See the [Teams page](https://docs.datadoghq.com/account_management/teams/)
for more information.
name: Teams
- description: Search or aggregate your test events over HTTP. See the [Test Optimization
in Datadog](https://docs.datadoghq.com/tests/) page for more information.
name: Test Optimization
- description: 'The usage metering API allows you to get hourly, daily, and

monthly usage across multiple facets of Datadog.
Expand Down
14 changes: 7 additions & 7 deletions docs/datadog_api_client.v2.api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,13 +81,6 @@ datadog\_api\_client.v2.api.ci\_visibility\_pipelines\_api module
:members:
:show-inheritance:

datadog\_api\_client.v2.api.ci\_visibility\_tests\_api module
-------------------------------------------------------------

.. automodule:: datadog_api_client.v2.api.ci_visibility_tests_api
:members:
:show-inheritance:

datadog\_api\_client.v2.api.cloud\_cost\_management\_api module
---------------------------------------------------------------

Expand Down Expand Up @@ -431,6 +424,13 @@ datadog\_api\_client.v2.api.teams\_api module
:members:
:show-inheritance:

datadog\_api\_client.v2.api.test\_optimization\_api module
----------------------------------------------------------

.. automodule:: datadog_api_client.v2.api.test_optimization_api
:members:
:show-inheritance:

datadog\_api\_client.v2.api.usage\_metering\_api module
-------------------------------------------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.ci_visibility_tests_api import CIVisibilityTestsApi
from datadog_api_client.v2.api.test_optimization_api import TestOptimizationApi
from datadog_api_client.v2.model.ci_app_aggregate_sort import CIAppAggregateSort
from datadog_api_client.v2.model.ci_app_aggregation_function import CIAppAggregationFunction
from datadog_api_client.v2.model.ci_app_compute import CIAppCompute
Expand Down Expand Up @@ -44,7 +44,7 @@

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CIVisibilityTestsApi(api_client)
api_instance = TestOptimizationApi(api_client)
response = api_instance.aggregate_ci_app_test_events(body=body)

print(response)
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
from datetime import datetime
from dateutil.relativedelta import relativedelta
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.ci_visibility_tests_api import CIVisibilityTestsApi
from datadog_api_client.v2.api.test_optimization_api import TestOptimizationApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CIVisibilityTestsApi(api_client)
api_instance = TestOptimizationApi(api_client)
response = api_instance.list_ci_app_test_events(
filter_query="@test.service:web-ui-tests",
filter_from=(datetime.now() + relativedelta(seconds=-30)),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
from datetime import datetime
from dateutil.relativedelta import relativedelta
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.ci_visibility_tests_api import CIVisibilityTestsApi
from datadog_api_client.v2.api.test_optimization_api import TestOptimizationApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CIVisibilityTestsApi(api_client)
api_instance = TestOptimizationApi(api_client)
items = api_instance.list_ci_app_test_events_with_pagination(
filter_from=(datetime.now() + relativedelta(seconds=-30)),
filter_to=datetime.now(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.ci_visibility_tests_api import CIVisibilityTestsApi
from datadog_api_client.v2.api.test_optimization_api import TestOptimizationApi
from datadog_api_client.v2.model.ci_app_query_options import CIAppQueryOptions
from datadog_api_client.v2.model.ci_app_query_page_options import CIAppQueryPageOptions
from datadog_api_client.v2.model.ci_app_sort import CIAppSort
Expand All @@ -27,7 +27,7 @@

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CIVisibilityTestsApi(api_client)
api_instance = TestOptimizationApi(api_client)
response = api_instance.search_ci_app_test_events(body=body)

print(response)
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.ci_visibility_tests_api import CIVisibilityTestsApi
from datadog_api_client.v2.api.test_optimization_api import TestOptimizationApi
from datadog_api_client.v2.model.ci_app_query_page_options import CIAppQueryPageOptions
from datadog_api_client.v2.model.ci_app_sort import CIAppSort
from datadog_api_client.v2.model.ci_app_test_events_request import CIAppTestEventsRequest
Expand All @@ -23,7 +23,7 @@

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = CIVisibilityTestsApi(api_client)
api_instance = TestOptimizationApi(api_client)
items = api_instance.search_ci_app_test_events_with_pagination(body=body)
for item in items:
print(item)
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
from datadog_api_client.v2.model.ci_app_test_events_request import CIAppTestEventsRequest


class CIVisibilityTestsApi:
class TestOptimizationApi:
"""
Search or aggregate your CI Visibility test events over HTTP. See the `Test Visibility in Datadog page <https://docs.datadoghq.com/tests/>`_ for more information.
Search or aggregate your test events over HTTP. See the `Test Optimization in Datadog <https://docs.datadoghq.com/tests/>`_ page for more information.
"""

def __init__(self, api_client=None):
Expand Down Expand Up @@ -128,7 +128,7 @@ def aggregate_ci_app_test_events(
) -> CIAppTestsAnalyticsAggregateResponse:
"""Aggregate tests events.

The API endpoint to aggregate CI Visibility test events into buckets of computed metrics and timeseries.
The API endpoint to aggregate test events into buckets of computed metrics and timeseries.

:type body: CIAppTestsAggregateRequest
:rtype: CIAppTestsAnalyticsAggregateResponse
Expand All @@ -150,7 +150,7 @@ def list_ci_app_test_events(
) -> CIAppTestEventsResponse:
"""Get a list of tests events.

List endpoint returns CI Visibility test events that match a `search query <https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/>`_.
List endpoint returns test events that match a `search query <https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/>`_.
`Results are paginated similarly to logs <https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination>`_.

Use this endpoint to see your latest test events.
Expand Down Expand Up @@ -259,7 +259,7 @@ def search_ci_app_test_events(
) -> CIAppTestEventsResponse:
"""Search tests events.

List endpoint returns CI Visibility test events that match a `search query <https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/>`_.
List endpoint returns test events that match a `search query <https://docs.datadoghq.com/continuous_integration/explorer/search_syntax/>`_.
`Results are paginated similarly to logs <https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination>`_.

Use this endpoint to build complex events filtering and search.
Expand Down
4 changes: 2 additions & 2 deletions src/datadog_api_client/v2/apis/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
from datadog_api_client.v2.api.audit_api import AuditApi
from datadog_api_client.v2.api.authn_mappings_api import AuthNMappingsApi
from datadog_api_client.v2.api.ci_visibility_pipelines_api import CIVisibilityPipelinesApi
from datadog_api_client.v2.api.ci_visibility_tests_api import CIVisibilityTestsApi
from datadog_api_client.v2.api.csm_agents_api import CSMAgentsApi
from datadog_api_client.v2.api.csm_coverage_analysis_api import CSMCoverageAnalysisApi
from datadog_api_client.v2.api.csm_threats_api import CSMThreatsApi
Expand Down Expand Up @@ -59,6 +58,7 @@
from datadog_api_client.v2.api.spans_metrics_api import SpansMetricsApi
from datadog_api_client.v2.api.synthetics_api import SyntheticsApi
from datadog_api_client.v2.api.teams_api import TeamsApi
from datadog_api_client.v2.api.test_optimization_api import TestOptimizationApi
from datadog_api_client.v2.api.usage_metering_api import UsageMeteringApi
from datadog_api_client.v2.api.users_api import UsersApi
from datadog_api_client.v2.api.workflow_automation_api import WorkflowAutomationApi
Expand All @@ -75,7 +75,6 @@
"AuditApi",
"AuthNMappingsApi",
"CIVisibilityPipelinesApi",
"CIVisibilityTestsApi",
"CSMAgentsApi",
"CSMCoverageAnalysisApi",
"CSMThreatsApi",
Expand Down Expand Up @@ -126,6 +125,7 @@
"SpansMetricsApi",
"SyntheticsApi",
"TeamsApi",
"TestOptimizationApi",
"UsageMeteringApi",
"UsersApi",
"WorkflowAutomationApi",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ def __init__(
"""
JSON object containing all event attributes and their associated values.

:param attributes: JSON object of attributes from CI Visibility test events.
:param attributes: JSON object of attributes from Test Optimization test events.
:type attributes: {str: (bool, date, datetime, dict, float, int, list, str, UUID, none_type,)}, optional

:param tags: Array of tags associated with your event.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
@endpoint(ci-visibility-tests) @endpoint(ci-visibility-tests-v2)
Feature: CI Visibility Tests
Search or aggregate your CI Visibility test events over HTTP. See the
[Test Visibility in Datadog page](https://docs.datadoghq.com/tests/) for
more information.
@endpoint(test-optimization) @endpoint(test-optimization-v2)
Feature: Test Optimization
Search or aggregate your test events over HTTP. See the [Test Optimization
in Datadog](https://docs.datadoghq.com/tests/) page for more information.

Background:
Given a valid "apiKeyAuth" key in the system
And a valid "appKeyAuth" key in the system
And an instance of "CIVisibilityTests" API
And an instance of "TestOptimization" API

@generated @skip @team:Datadog/ci-app-backend
Scenario: Aggregate tests events returns "Bad Request" response
Expand Down
6 changes: 3 additions & 3 deletions tests/v2/features/undo.json
Original file line number Diff line number Diff line change
Expand Up @@ -453,19 +453,19 @@
}
},
"AggregateCIAppTestEvents": {
"tag": "CI Visibility Tests",
"tag": "Test Optimization",
"undo": {
"type": "safe"
}
},
"ListCIAppTestEvents": {
"tag": "CI Visibility Tests",
"tag": "Test Optimization",
"undo": {
"type": "safe"
}
},
"SearchCIAppTestEvents": {
"tag": "CI Visibility Tests",
"tag": "Test Optimization",
"undo": {
"type": "safe"
}
Expand Down