Add OpenAPI documentation for forms endpoints

docs/datadog_api_client.v2.api.rst

@@ -270,6 +270,13 @@ datadog\_api\_client.v2.api.fleet\_automation\_api module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.api.forms\_api module
+---------------------------------------------
+
+.. automodule:: datadog_api_client.v2.api.forms_api
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.api.gcp\_integration\_api module
 --------------------------------------------------------
 

docs/datadog_api_client.v2.model.rst

@@ -10518,6 +10518,251 @@ datadog\_api\_client.v2.model.fleet\_schedules\_response module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.form\_create\_request module
+----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_create_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_data\_attributes\_request module
+--------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_data_attributes_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_data\_attributes\_response module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_data_attributes_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_data\_request module
+--------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_data_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_data\_response module
+---------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_data_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_datastore\_config module
+------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_datastore_config
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_publication module
+------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_publication
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_publication\_attributes module
+------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_publication_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_publication\_data\_request module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_publication_data_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_publication\_data\_response module
+----------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_publication_data_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_publication\_request module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_publication_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_publication\_response module
+----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_publication_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_publication\_type module
+------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_publication_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_response module
+---------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_submission\_attributes module
+-----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_submission_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_submission\_data\_request module
+--------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_submission_data_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_submission\_data\_response module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_submission_data_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_submission\_request module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_submission_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_submission\_response module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_submission_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_submission\_type module
+-----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_submission_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_type module
+-----------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_update\_attributes module
+-------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_update_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_update\_attributes\_form\_update module
+---------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_update_attributes_form_update
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_update\_data\_request module
+----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_update_data_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_update\_request module
+----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_update_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_version\_attributes module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_version_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_version\_data\_attributes\_response module
+------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_version_data_attributes_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_version\_data\_request module
+-----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_version_data_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_version\_data\_response module
+------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_version_data_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_version\_request module
+-----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_version_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_version\_response module
+------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_version_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_version\_state module
+---------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_version_state
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_version\_type module
+--------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_version_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.form\_version\_upsert\_params module
+------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.form_version_upsert_params
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.forms\_list\_response module
+----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.forms_list_response
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.formula\_limit module
 ---------------------------------------------------
 

examples/v2/forms/CreateAndPublishForm.py

@@ -0,0 +1,32 @@
+"""
+Create and publish a form returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.forms_api import FormsApi
+from datadog_api_client.v2.model.form_create_request import FormCreateRequest
+from datadog_api_client.v2.model.form_data_attributes_request import FormDataAttributesRequest
+from datadog_api_client.v2.model.form_data_request import FormDataRequest
+from datadog_api_client.v2.model.form_type import FormType
+from uuid import UUID
+
+body = FormCreateRequest(
+    data=FormDataRequest(
+        attributes=FormDataAttributesRequest(
+            data_definition=dict(),
+            description="test description",
+            name="test form happy path",
+            ui_definition=dict(),
+        ),
+        id=UUID("00000000-0000-0000-0000-000000000000"),
+        type=FormType.FORMS,
+    ),
+)
+
+configuration = Configuration()
+configuration.unstable_operations["create_and_publish_form"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = FormsApi(api_client)
+    response = api_instance.create_and_publish_form(body=body)
+
+    print(response)

examples/v2/forms/CreateForm.py

@@ -0,0 +1,32 @@
+"""
+Create a new form returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.forms_api import FormsApi
+from datadog_api_client.v2.model.form_create_request import FormCreateRequest
+from datadog_api_client.v2.model.form_data_attributes_request import FormDataAttributesRequest
+from datadog_api_client.v2.model.form_data_request import FormDataRequest
+from datadog_api_client.v2.model.form_type import FormType
+from uuid import UUID
+
+body = FormCreateRequest(
+    data=FormDataRequest(
+        attributes=FormDataAttributesRequest(
+            data_definition=dict(),
+            description="test description",
+            name="test form happy path",
+            ui_definition=dict(),
+        ),
+        id=UUID("00000000-0000-0000-0000-000000000000"),
+        type=FormType.FORMS,
+    ),
+)
+
+configuration = Configuration()
+configuration.unstable_operations["create_form"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = FormsApi(api_client)
+    response = api_instance.create_form(body=body)
+
+    print(response)

examples/v2/forms/DeleteForm.py

@@ -0,0 +1,15 @@
+"""
+Delete a form returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.forms_api import FormsApi
+from uuid import UUID
+
+configuration = Configuration()
+configuration.unstable_operations["delete_form"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = FormsApi(api_client)
+    api_instance.delete_form(
+        form_id=UUID("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"),
+    )

examples/v2/forms/GetForm.py

@@ -0,0 +1,17 @@
+"""
+Get a form returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.forms_api import FormsApi
+from uuid import UUID
+
+configuration = Configuration()
+configuration.unstable_operations["get_form"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = FormsApi(api_client)
+    response = api_instance.get_form(
+        form_id=UUID("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"),
+    )
+
+    print(response)

examples/v2/forms/ListForms.py

@@ -0,0 +1,14 @@
+"""
+List all forms returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.forms_api import FormsApi
+
+configuration = Configuration()
+configuration.unstable_operations["list_forms"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = FormsApi(api_client)
+    response = api_instance.list_forms()
+
+    print(response)