Skip to content

Add public OpenAPI spec for report schedule create and update #3627

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.

Sign up for GitHub

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
api-clients-generation-pipeline merged 1 commit into from
Jun 11, 2026
Merged

Add public OpenAPI spec for report schedule create and update #3627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
648 changes: 648 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions docs/datadog_api_client.v2.api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -613,6 +613,13 @@ datadog\_api\_client.v2.api.reference\_tables\_api module
:members:
:show-inheritance:

datadog\_api\_client.v2.api.report\_schedules\_api module
---------------------------------------------------------

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

datadog\_api\_client.v2.api.restriction\_policies\_api module
-------------------------------------------------------------

Expand Down
154 changes: 154 additions & 0 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31112,6 +31112,160 @@ datadog\_api\_client.v2.model.reorder\_ruleset\_resource\_data\_type module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_author module
-------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_author
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_author\_attributes module
-------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_author_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_author\_relationship module
---------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_author_relationship
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_author\_relationship\_data module
---------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_author_relationship_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_author\_type module
-------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_author_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_create\_request module
----------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_create_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_create\_request\_attributes module
----------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_create_request_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_create\_request\_data module
----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_create_request_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_delivery\_format module
-----------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_delivery_format
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_included\_resource module
-------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_included_resource
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_patch\_request module
---------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_patch_request
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_patch\_request\_attributes module
---------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_patch_request_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_patch\_request\_data module
---------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_patch_request_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_resource\_type module
---------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_resource_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_response module
---------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_response
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_response\_attributes module
---------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_response_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_response\_attributes\_delivery\_format module
---------------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_response_attributes_delivery_format
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_response\_data module
---------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_response_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_response\_relationships module
------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_response_relationships
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_status module
-------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_status
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_template\_variable module
-------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_template_variable
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_type module
-----------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.report_schedule_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.resolve\_vulnerable\_symbols\_request module
--------------------------------------------------------------------------

Expand Down
52 changes: 52 additions & 0 deletions examples/v2/report-schedules/CreateReportSchedule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
"""
Create a report schedule returns "CREATED" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.report_schedules_api import ReportSchedulesApi
from datadog_api_client.v2.model.report_schedule_create_request import ReportScheduleCreateRequest
from datadog_api_client.v2.model.report_schedule_create_request_attributes import ReportScheduleCreateRequestAttributes
from datadog_api_client.v2.model.report_schedule_create_request_data import ReportScheduleCreateRequestData
from datadog_api_client.v2.model.report_schedule_delivery_format import ReportScheduleDeliveryFormat
from datadog_api_client.v2.model.report_schedule_resource_type import ReportScheduleResourceType
from datadog_api_client.v2.model.report_schedule_template_variable import ReportScheduleTemplateVariable
from datadog_api_client.v2.model.report_schedule_type import ReportScheduleType
from uuid import UUID

body = ReportScheduleCreateRequest(
data=ReportScheduleCreateRequestData(
attributes=ReportScheduleCreateRequestAttributes(
delivery_format=ReportScheduleDeliveryFormat.PDF,
description="Weekly summary of infrastructure health.",
recipients=[
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2",
],
resource_id="abc-def-ghi",
resource_type=ReportScheduleResourceType.DASHBOARD,
rrule="DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
tab_id=UUID("66666666-7777-8888-9999-000000000000"),
template_variables=[
ReportScheduleTemplateVariable(
name="env",
values=[
"prod",
],
),
],
timeframe="calendar_month",
timezone="America/New_York",
title="Weekly Infrastructure Report",
),
type=ReportScheduleType.SCHEDULE,
),
)

configuration = Configuration()
configuration.unstable_operations["create_report_schedule"] = True
with ApiClient(configuration) as api_client:
api_instance = ReportSchedulesApi(api_client)
response = api_instance.create_report_schedule(body=body)

print(response)
49 changes: 49 additions & 0 deletions examples/v2/report-schedules/PatchReportSchedule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
"""
Update a report schedule returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.report_schedules_api import ReportSchedulesApi
from datadog_api_client.v2.model.report_schedule_delivery_format import ReportScheduleDeliveryFormat
from datadog_api_client.v2.model.report_schedule_patch_request import ReportSchedulePatchRequest
from datadog_api_client.v2.model.report_schedule_patch_request_attributes import ReportSchedulePatchRequestAttributes
from datadog_api_client.v2.model.report_schedule_patch_request_data import ReportSchedulePatchRequestData
from datadog_api_client.v2.model.report_schedule_template_variable import ReportScheduleTemplateVariable
from datadog_api_client.v2.model.report_schedule_type import ReportScheduleType
from uuid import UUID

body = ReportSchedulePatchRequest(
data=ReportSchedulePatchRequestData(
attributes=ReportSchedulePatchRequestAttributes(
delivery_format=ReportScheduleDeliveryFormat.PDF,
description="Updated weekly summary of infrastructure health.",
recipients=[
"user@example.com",
"slack:T01234567.C01234567.alerts",
"teams:11111111-1111-1111-1111-111111111111|22222222-2222-2222-2222-222222222222|19:exampleChannelId@thread.tacv2",
],
rrule="DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0",
tab_id=UUID("66666666-7777-8888-9999-000000000000"),
template_variables=[
ReportScheduleTemplateVariable(
name="env",
values=[
"prod",
],
),
],
timeframe="calendar_month",
timezone="America/New_York",
title="Weekly Infrastructure Report",
),
type=ReportScheduleType.SCHEDULE,
),
)

configuration = Configuration()
configuration.unstable_operations["patch_report_schedule"] = True
with ApiClient(configuration) as api_client:
api_instance = ReportSchedulesApi(api_client)
response = api_instance.patch_report_schedule(schedule_uuid=UUID("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"), body=body)

print(response)
2 changes: 2 additions & 0 deletions src/datadog_api_client/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -651,6 +651,8 @@ def __init__(
"v2.update_connection": False,
"v2.get_pruned_trace_by_id": False,
"v2.get_trace_by_id": False,
"v2.create_report_schedule": False,
"v2.patch_report_schedule": False,
"v2.delete_sourcemaps": False,
"v2.get_service_repository_info": False,
"v2.get_sourcemaps": False,
Expand Down
Loading
Loading