Skip to content

Add OpenAPI documentation for wf-generation-api endpoints #3187

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

Closed
api-clients-generation-pipeline wants to merge 1 commit into from
Closed

Add OpenAPI documentation for wf-generation-api endpoints #3187

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

Large diffs are not rendered by default.

189 changes: 189 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 @@ -60,6 +60,13 @@ datadog\_api\_client.v2.model.action\_connection\_integration\_update module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.action\_match module
--------------------------------------------------

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

datadog\_api\_client.v2.model.action\_query module
--------------------------------------------------

Expand Down Expand Up @@ -221,6 +228,13 @@ datadog\_api\_client.v2.model.advisory module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.agentic\_event module
---------------------------------------------------

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

datadog\_api\_client.v2.model.alert\_event\_attributes module
-------------------------------------------------------------

Expand Down Expand Up @@ -3560,6 +3574,34 @@ datadog\_api\_client.v2.model.chargeback\_breakdown module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.chat\_history\_item module
--------------------------------------------------------

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

datadog\_api\_client.v2.model.chat\_history\_item\_role module
--------------------------------------------------------------

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

datadog\_api\_client.v2.model.chat\_message module
--------------------------------------------------

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

datadog\_api\_client.v2.model.chat\_message\_role module
--------------------------------------------------------

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

datadog\_api\_client.v2.model.ci\_app\_aggregate\_bucket\_value module
----------------------------------------------------------------------

Expand Down Expand Up @@ -4190,6 +4232,13 @@ datadog\_api\_client.v2.model.clickup\_integration\_update module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.client\_type module
-------------------------------------------------

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

datadog\_api\_client.v2.model.cloud\_asset\_type module
-------------------------------------------------------

Expand Down Expand Up @@ -6416,6 +6465,20 @@ datadog\_api\_client.v2.model.csm\_serverless\_coverage\_analysis\_response modu
:members:
:show-inheritance:

datadog\_api\_client.v2.model.custom\_agent\_conversation\_request module
-------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_agent\_conversation\_stream\_response module
----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.custom\_attribute\_config module
--------------------------------------------------------------

Expand Down Expand Up @@ -7305,6 +7368,48 @@ datadog\_api\_client.v2.model.data\_transform\_type module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.data\_transformation\_context module
------------------------------------------------------------------

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

datadog\_api\_client.v2.model.data\_transformation\_description\_request module
-------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.data\_transformation\_description\_response module
--------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.data\_transformation\_language module
-------------------------------------------------------------------

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

datadog\_api\_client.v2.model.data\_transformation\_request module
------------------------------------------------------------------

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

datadog\_api\_client.v2.model.data\_transformation\_stream\_response module
---------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.database\_monitoring\_trigger\_wrapper module
---------------------------------------------------------------------------

Expand Down Expand Up @@ -19779,6 +19884,34 @@ datadog\_api\_client.v2.model.permissions\_type module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.pick\_action\_request module
----------------------------------------------------------

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

datadog\_api\_client.v2.model.pick\_action\_response module
-----------------------------------------------------------

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

datadog\_api\_client.v2.model.pick\_remediation\_from\_investigation\_request module
------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.pick\_remediation\_from\_investigation\_response module
-------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.playlist module
---------------------------------------------

Expand Down Expand Up @@ -26464,6 +26597,13 @@ datadog\_api\_client.v2.model.split\_integration\_update module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.stability\_level module
-----------------------------------------------------

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

datadog\_api\_client.v2.model.state module
------------------------------------------

Expand Down Expand Up @@ -26982,6 +27122,13 @@ datadog\_api\_client.v2.model.step\_display\_bounds module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.stream\_event\_v1 module
------------------------------------------------------

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

datadog\_api\_client.v2.model.suite\_create\_edit module
--------------------------------------------------------

Expand Down Expand Up @@ -29187,6 +29334,13 @@ datadog\_api\_client.v2.model.user\_attributes\_status module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.user\_context module
--------------------------------------------------

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

datadog\_api\_client.v2.model.user\_create\_attributes module
-------------------------------------------------------------

Expand All @@ -29208,6 +29362,13 @@ datadog\_api\_client.v2.model.user\_create\_request module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.user\_info module
-----------------------------------------------

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

datadog\_api\_client.v2.model.user\_invitation\_data module
-----------------------------------------------------------

Expand Down Expand Up @@ -29845,6 +30006,20 @@ datadog\_api\_client.v2.model.workflow\_data\_update\_attributes module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.workflow\_description\_request module
-------------------------------------------------------------------

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

datadog\_api\_client.v2.model.workflow\_description\_response module
--------------------------------------------------------------------

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

datadog\_api\_client.v2.model.workflow\_instance\_create\_meta module
---------------------------------------------------------------------

Expand Down Expand Up @@ -29901,6 +30076,20 @@ datadog\_api\_client.v2.model.workflow\_list\_instances\_response\_meta\_page mo
:members:
:show-inheritance:

datadog\_api\_client.v2.model.workflow\_scaffold\_agentic\_stream\_request module
---------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.workflow\_scaffold\_agentic\_stream\_response module
----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.workflow\_trigger\_wrapper module
---------------------------------------------------------------

Expand Down
21 changes: 21 additions & 0 deletions examples/v2/workflow-automation/CreateCustomAgentConversation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
"""
Create a custom agent conversation returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.workflow_automation_api import WorkflowAutomationApi
from datadog_api_client.v2.model.custom_agent_conversation_request import CustomAgentConversationRequest
from uuid import UUID

body = CustomAgentConversationRequest(
conversation_id="550e8400-e29b-41d4-a716-446655440000",
user_prompt="What is the weather like today?",
)

configuration = Configuration()
configuration.unstable_operations["create_custom_agent_conversation"] = True
with ApiClient(configuration) as api_client:
api_instance = WorkflowAutomationApi(api_client)
response = api_instance.create_custom_agent_conversation(
custom_agent_id=UUID("3b796bda-b79b-477e-ae29-958473a683db"), body=body
)
33 changes: 33 additions & 0 deletions examples/v2/workflow-automation/CreateDataTransformation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
"""
Generate data transformation code returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.workflow_automation_api import WorkflowAutomationApi
from datadog_api_client.v2.model.chat_history_item import ChatHistoryItem
from datadog_api_client.v2.model.chat_history_item_role import ChatHistoryItemRole
from datadog_api_client.v2.model.data_transformation_context import DataTransformationContext
from datadog_api_client.v2.model.data_transformation_language import DataTransformationLanguage
from datadog_api_client.v2.model.data_transformation_request import DataTransformationRequest

body = DataTransformationRequest(
chat_history=[
ChatHistoryItem(
content="Please add error handling",
role=ChatHistoryItemRole.USER,
),
],
context=DataTransformationContext(
context_variables='{ "timestamp": 1234567890 }',
current_script="return data.timestamp;",
),
language=DataTransformationLanguage.JAVASCRIPT,
stream=True,
user_prompt="Convert timestamp to ISO format",
)

configuration = Configuration()
configuration.unstable_operations["create_data_transformation"] = True
with ApiClient(configuration) as api_client:
api_instance = WorkflowAutomationApi(api_client)
response = api_instance.create_data_transformation(body=body)
20 changes: 20 additions & 0 deletions examples/v2/workflow-automation/CreateDataTransformationDescription.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
"""
Generate data transformation description returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.workflow_automation_api import WorkflowAutomationApi
from datadog_api_client.v2.model.data_transformation_description_request import DataTransformationDescriptionRequest

body = DataTransformationDescriptionRequest(
action_id="com.datadoghq.transform.timestamp",
script="return new Date(data.timestamp).toISOString();",
)

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

print(response)
24 changes: 24 additions & 0 deletions examples/v2/workflow-automation/CreatePickAction.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
"""
Pick relevant actions returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.workflow_automation_api import WorkflowAutomationApi
from datadog_api_client.v2.model.client_type import ClientType
from datadog_api_client.v2.model.pick_action_request import PickActionRequest
from datadog_api_client.v2.model.stability_level import StabilityLevel

body = PickActionRequest(
client=ClientType.WORKFLOWS,
number_of_relevant_actions=5,
stability=StabilityLevel.STABLE,
user_prompt="Send a Slack message",
)

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

print(response)
Loading