Skip to content

Add OpenAPI documentation for k9-integration-api endpoints #3188

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 k9-integration-api endpoints #3188

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

Large diffs are not rendered by default.

105 changes: 105 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 @@ -7137,6 +7137,97 @@ datadog\_api\_client.v2.model.cvss module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.cyclone\_dx\_advisory module
----------------------------------------------------------

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

datadog\_api\_client.v2.model.cyclone\_dx\_affect module
--------------------------------------------------------

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

datadog\_api\_client.v2.model.cyclone\_dx\_asset\_component module
------------------------------------------------------------------

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

datadog\_api\_client.v2.model.cyclone\_dx\_component module
-----------------------------------------------------------

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

datadog\_api\_client.v2.model.cyclone\_dx\_component\_type module
-----------------------------------------------------------------

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

datadog\_api\_client.v2.model.cyclone\_dx\_metadata module
----------------------------------------------------------

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

datadog\_api\_client.v2.model.cyclone\_dx\_rating module
--------------------------------------------------------

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

datadog\_api\_client.v2.model.cyclone\_dx\_reference module
-----------------------------------------------------------

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

datadog\_api\_client.v2.model.cyclone\_dx\_reference\_source module
-------------------------------------------------------------------

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

datadog\_api\_client.v2.model.cyclone\_dx\_tool\_component module
-----------------------------------------------------------------

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

datadog\_api\_client.v2.model.cyclone\_dx\_tools module
-------------------------------------------------------

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

datadog\_api\_client.v2.model.cyclone\_dx\_vulnerability module
---------------------------------------------------------------

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

datadog\_api\_client.v2.model.cyclone\_dxbom module
---------------------------------------------------

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

datadog\_api\_client.v2.model.dashboard\_list\_add\_items\_request module
-------------------------------------------------------------------------

Expand Down Expand Up @@ -23419,6 +23510,13 @@ datadog\_api\_client.v2.model.security\_filters\_response module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.security\_finding\_type module
------------------------------------------------------------

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

datadog\_api\_client.v2.model.security\_findings\_attributes module
-------------------------------------------------------------------

Expand Down Expand Up @@ -28242,6 +28340,13 @@ datadog\_api\_client.v2.model.threat\_hunting\_job\_response\_data module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.threat\_intel\_indicator\_type module
-------------------------------------------------------------------

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

datadog\_api\_client.v2.model.time\_restriction module
------------------------------------------------------

Expand Down
16 changes: 16 additions & 0 deletions examples/v2/security-monitoring/CreateSecurityFinding.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Create security finding 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_finding_type import SecurityFindingType

configuration = Configuration()
configuration.unstable_operations["create_security_finding"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
api_instance.create_security_finding(
vendor="vendor",
finding_type=SecurityFindingType.VULNERABILITY,
)
91 changes: 91 additions & 0 deletions examples/v2/security-monitoring/ImportSecurityVulnerabilities.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
"""
Import vulnerabilities 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.cyclone_dx_advisory import CycloneDXAdvisory
from datadog_api_client.v2.model.cyclone_dx_affect import CycloneDXAffect
from datadog_api_client.v2.model.cyclone_dx_asset_component import CycloneDXAssetComponent
from datadog_api_client.v2.model.cyclone_dx_component import CycloneDXComponent
from datadog_api_client.v2.model.cyclone_dx_component_type import CycloneDXComponentType
from datadog_api_client.v2.model.cyclone_dx_metadata import CycloneDXMetadata
from datadog_api_client.v2.model.cyclone_dx_rating import CycloneDXRating
from datadog_api_client.v2.model.cyclone_dx_reference import CycloneDXReference
from datadog_api_client.v2.model.cyclone_dx_reference_source import CycloneDXReferenceSource
from datadog_api_client.v2.model.cyclone_dx_tool_component import CycloneDXToolComponent
from datadog_api_client.v2.model.cyclone_dx_tools import CycloneDXTools
from datadog_api_client.v2.model.cyclone_dx_vulnerability import CycloneDXVulnerability
from datadog_api_client.v2.model.cyclone_dxbom import CycloneDXBOM

body = CycloneDXBOM(
bom_format="CycloneDX",
components=[
CycloneDXComponent(
bom_ref="a3390fca-c315-41ae-ae05-af5e7859cdee",
name="lodash",
purl="pkg:npm/lodash@4.17.21",
type=CycloneDXComponentType.LIBRARY,
version="4.17.21",
),
],
metadata=CycloneDXMetadata(
component=CycloneDXAssetComponent(
bom_ref="asset-ref-123",
name="i-12345",
type="operating-system",
),
tools=CycloneDXTools(
components=[
CycloneDXToolComponent(
name="my-scanner",
type="application",
),
],
),
),
spec_version="1.5",
version=1,
vulnerabilities=[
CycloneDXVulnerability(
advisories=[
CycloneDXAdvisory(
url="https://example.com/advisory/CVE-2021-1234",
),
],
affects=[
CycloneDXAffect(
ref="a3390fca-c315-41ae-ae05-af5e7859cdee",
),
],
cwes=[
123,
345,
],
description="Sample vulnerability detected in the application.",
detail="Details about the vulnerability",
id="CVE-2021-1234",
ratings=[
CycloneDXRating(
score=9.0,
severity="high",
vector="CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:C/C:H/I:H/A:N",
),
],
references=[
CycloneDXReference(
id="GHSA-35m5-8cvj-8783",
source=CycloneDXReferenceSource(
url="https://example.com",
),
),
],
),
],
)

configuration = Configuration()
configuration.unstable_operations["import_security_vulnerabilities"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
api_instance.import_security_vulnerabilities(body=body)
16 changes: 16 additions & 0 deletions examples/v2/security-monitoring/ImportThreatIntel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Import threat intelligence feed 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.threat_intel_indicator_type import ThreatIntelIndicatorType

configuration = Configuration()
configuration.unstable_operations["import_threat_intel"] = True
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
api_instance.import_threat_intel(
ti_vendor="ti_vendor",
ti_indicator=ThreatIntelIndicatorType.IP_ADDRESS,
)
3 changes: 3 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 @@ -276,6 +276,7 @@ def __init__(
"v2.activate_content_pack": False,
"v2.cancel_threat_hunting_job": False,
"v2.convert_job_result_to_signal": False,
"v2.create_security_finding": False,
"v2.deactivate_content_pack": False,
"v2.delete_threat_hunting_job": False,
"v2.get_content_packs_states": False,
Expand All @@ -285,6 +286,8 @@ def __init__(
"v2.get_security_monitoring_histsignal": False,
"v2.get_security_monitoring_histsignals_by_job_id": False,
"v2.get_threat_hunting_job": False,
"v2.import_security_vulnerabilities": False,
"v2.import_threat_intel": False,
"v2.list_findings": False,
"v2.list_multiple_rulesets": False,
"v2.list_scanned_assets_metadata": False,
Expand Down
Loading