Skip to content

Add OpenAPI documentation for secmon-public-api datasets endpoints #3136

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 documentation for secmon-public-api datasets endpoints #3136

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

Large diffs are not rendered by default.

175 changes: 175 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 @@ -22789,6 +22789,181 @@ datadog\_api\_client.v2.model.security\_monitoring\_critical\_assets\_response m
:members:
:show-inheritance:

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_attributes\_response module
----------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_create\_attributes\_request module
-----------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_create\_data\_request module
-----------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_create\_data\_response module
------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_create\_request module
-----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_create\_response module
------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_data\_response module
----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_definition module
------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_definition\_column module
--------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_definition\_column\_type module
--------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_dependencies\_attributes\_request module
-----------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_dependencies\_data\_request module
-----------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_dependencies\_request module
-----------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_dependencies\_response module
------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_dependencies\_type module
--------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_dependency\_attributes\_response module
----------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_dependency\_data\_response module
----------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_list\_meta module
------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_response module
----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_type module
------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_update\_attributes\_request module
-----------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_update\_data\_request module
-----------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_dataset\_update\_request module
-----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_datasets\_history\_response module
--------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_datasets\_list\_response module
-----------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_monitoring\_filter module
-----------------------------------------------------------------

Expand Down
37 changes: 37 additions & 0 deletions examples/v2/security-monitoring/BatchGetSecurityMonitoringDatasetDependencies.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
"""
Get dataset dependencies returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
from datadog_api_client.v2.model.security_monitoring_dataset_dependencies_attributes_request import (
SecurityMonitoringDatasetDependenciesAttributesRequest,
)
from datadog_api_client.v2.model.security_monitoring_dataset_dependencies_data_request import (
SecurityMonitoringDatasetDependenciesDataRequest,
)
from datadog_api_client.v2.model.security_monitoring_dataset_dependencies_request import (
SecurityMonitoringDatasetDependenciesRequest,
)
from datadog_api_client.v2.model.security_monitoring_dataset_dependencies_type import (
SecurityMonitoringDatasetDependenciesType,
)

body = SecurityMonitoringDatasetDependenciesRequest(
data=SecurityMonitoringDatasetDependenciesDataRequest(
attributes=SecurityMonitoringDatasetDependenciesAttributesRequest(
dataset_ids=[
"dataset-1",
],
),
type=SecurityMonitoringDatasetDependenciesType.SECURITY_MONITORING_DATASET_DEPENDENCIES,
),
)

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

print(response)
53 changes: 53 additions & 0 deletions examples/v2/security-monitoring/CreateSecurityMonitoringDataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
"""
Create a dataset returns "Created" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
from datadog_api_client.v2.model.security_monitoring_dataset_create_attributes_request import (
SecurityMonitoringDatasetCreateAttributesRequest,
)
from datadog_api_client.v2.model.security_monitoring_dataset_create_data_request import (
SecurityMonitoringDatasetCreateDataRequest,
)
from datadog_api_client.v2.model.security_monitoring_dataset_create_request import (
SecurityMonitoringDatasetCreateRequest,
)
from datadog_api_client.v2.model.security_monitoring_dataset_definition import SecurityMonitoringDatasetDefinition
from datadog_api_client.v2.model.security_monitoring_dataset_definition_column import (
SecurityMonitoringDatasetDefinitionColumn,
)
from datadog_api_client.v2.model.security_monitoring_dataset_definition_column_type import (
SecurityMonitoringDatasetDefinitionColumnType,
)
from datadog_api_client.v2.model.security_monitoring_dataset_type import SecurityMonitoringDatasetType

body = SecurityMonitoringDatasetCreateRequest(
data=SecurityMonitoringDatasetCreateDataRequest(
attributes=SecurityMonitoringDatasetCreateAttributesRequest(
definition=SecurityMonitoringDatasetDefinition(
columns=[
SecurityMonitoringDatasetDefinitionColumn(
column="message",
type=SecurityMonitoringDatasetDefinitionColumnType.STRING,
),
],
data_source="logs",
indexes=[
"k9",
],
name="my_dataset",
),
description="A dataset for monitoring authentication events",
),
type=SecurityMonitoringDatasetType.SECURITY_MONITORING_DATASET,
),
)

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

print(response)
15 changes: 15 additions & 0 deletions examples/v2/security-monitoring/DeleteSecurityMonitoringDataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
"""
Delete a dataset returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
from uuid import UUID

configuration = Configuration()
configuration.unstable_operations["delete_security_monitoring_dataset"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
api_instance.delete_security_monitoring_dataset(
dataset_id=UUID("123e4567-e89b-12d3-a456-426614174000"),
)
17 changes: 17 additions & 0 deletions examples/v2/security-monitoring/GetSecurityMonitoringDataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
"""
Get a dataset returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
from uuid import UUID

configuration = Configuration()
configuration.unstable_operations["get_security_monitoring_dataset"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.get_security_monitoring_dataset(
dataset_id=UUID("123e4567-e89b-12d3-a456-426614174000"),
)

print(response)
18 changes: 18 additions & 0 deletions examples/v2/security-monitoring/GetSecurityMonitoringDatasetByVersion.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
"""
Get a dataset by version returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
from uuid import UUID

configuration = Configuration()
configuration.unstable_operations["get_security_monitoring_dataset_by_version"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.get_security_monitoring_dataset_by_version(
dataset_id=UUID("123e4567-e89b-12d3-a456-426614174000"),
version=1,
)

print(response)
17 changes: 17 additions & 0 deletions examples/v2/security-monitoring/GetSecurityMonitoringDatasetHistory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
"""
Get dataset history returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
from uuid import UUID

configuration = Configuration()
configuration.unstable_operations["get_security_monitoring_dataset_history"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.get_security_monitoring_dataset_history(
dataset_id=UUID("123e4567-e89b-12d3-a456-426614174000"),
)

print(response)
14 changes: 14 additions & 0 deletions examples/v2/security-monitoring/ListSecurityMonitoringDatasets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"""
List all datasets returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi

configuration = Configuration()
configuration.unstable_operations["list_security_monitoring_datasets"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.list_security_monitoring_datasets()

print(response)
Loading