Skip to content

Add OpenAPI specs for reporting schedule endpoints #3684

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

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add OpenAPI specs for reporting schedule endpoints #3684

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
815 changes: 812 additions & 3 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

126 changes: 126 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 @@ -31546,6 +31546,90 @@ datadog\_api\_client.v2.model.report\_schedule\_included\_resource module
:members:
:show-inheritance:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Expand All @@ -31567,6 +31651,27 @@ datadog\_api\_client.v2.model.report\_schedule\_patch\_request\_data module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.report\_schedule\_query\_parameter\_value module
------------------------------------------------------------------------------

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

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

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

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

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

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

Expand Down Expand Up @@ -31623,6 +31728,27 @@ datadog\_api\_client.v2.model.report\_schedule\_template\_variable module
:members:
:show-inheritance:

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

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

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

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

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion examples/v2/report-schedules/CreateReportSchedule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
],
),
],
timeframe="calendar_month",
timeframe="1w",
timezone="America/New_York",
title="Weekly Infrastructure Report",
),
Expand Down
16 changes: 16 additions & 0 deletions examples/v2/report-schedules/DeleteReportSchedule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Delete 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 uuid import UUID

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

print(response)
16 changes: 16 additions & 0 deletions examples/v2/report-schedules/GetReportSchedule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Get 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 uuid import UUID

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

print(response)
17 changes: 17 additions & 0 deletions examples/v2/report-schedules/GetReportSchedulesForResource.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
"""
Get report schedules for a resource 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_resource_type import ReportScheduleResourceType

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = ReportSchedulesApi(api_client)
response = api_instance.get_report_schedules_for_resource(
resource_type=ReportScheduleResourceType.DASHBOARD,
resource_id="resource_id",
)

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

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.report_schedules_api import ReportSchedulesApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = ReportSchedulesApi(api_client)
response = api_instance.list_report_schedules()

print(response)
2 changes: 1 addition & 1 deletion examples/v2/report-schedules/PatchReportSchedule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
],
),
],
timeframe="calendar_month",
timeframe="1w",
timezone="America/New_York",
title="Weekly Infrastructure Report",
),
Expand Down
30 changes: 30 additions & 0 deletions examples/v2/report-schedules/ToggleReportSchedule.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
"""
Toggle 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_status import ReportScheduleStatus
from datadog_api_client.v2.model.report_schedule_toggle_request import ReportScheduleToggleRequest
from datadog_api_client.v2.model.report_schedule_toggle_request_attributes import ReportScheduleToggleRequestAttributes
from datadog_api_client.v2.model.report_schedule_toggle_request_data import ReportScheduleToggleRequestData
from datadog_api_client.v2.model.report_schedule_type import ReportScheduleType
from uuid import UUID

body = ReportScheduleToggleRequest(
data=ReportScheduleToggleRequestData(
attributes=ReportScheduleToggleRequestAttributes(
status=ReportScheduleStatus.ACTIVE,
),
type=ReportScheduleType.SCHEDULE,
),
)

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

print(response)
Loading
Loading