Skip to content

Add OpenAPI spec for CSM ownership-api endpoints #3668

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 spec for CSM ownership-api endpoints #3668

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

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions docs/datadog_api_client.v2.api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,13 @@ datadog\_api\_client.v2.api.csm\_coverage\_analysis\_api module
:members:
:show-inheritance:

datadog\_api\_client.v2.api.csm\_ownership\_api module
------------------------------------------------------

.. automodule:: datadog_api_client.v2.api.csm_ownership_api
:members:
:show-inheritance:

datadog\_api\_client.v2.api.csm\_settings\_api module
-----------------------------------------------------

Expand Down
217 changes: 217 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 @@ -28620,6 +28620,223 @@ datadog\_api\_client.v2.model.overwrite\_allocations\_request module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.ownership\_evidence\_attributes module
--------------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_evidence\_data module
--------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_evidence\_response module
------------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_evidence\_type module
--------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_feedback\_action module
----------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_feedback\_request module
-----------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_feedback\_request\_attributes module
-----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_feedback\_request\_data module
-----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_feedback\_response module
------------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_feedback\_result\_attributes module
----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_feedback\_result\_data module
----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_feedback\_result\_type module
----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_feedback\_type module
--------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_history\_attributes module
-------------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_history\_data module
-------------------------------------------------------------

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

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

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

datadog\_api\_client.v2.model.ownership\_history\_pagination module
-------------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_history\_response module
-----------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_history\_type module
-------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_inference\_attributes module
---------------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_inference\_data module
---------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_inference\_item module
---------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_inference\_list\_attributes module
---------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_inference\_list\_data module
---------------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_inference\_list\_response module
-------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_inference\_response module
-------------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_inference\_source module
-----------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_inference\_status module
-----------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_inference\_type module
---------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_inferences\_type module
----------------------------------------------------------------

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

datadog\_api\_client.v2.model.ownership\_owner\_type module
-----------------------------------------------------------

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

datadog\_api\_client.v2.model.page\_annotations\_attributes module
------------------------------------------------------------------

Expand Down
37 changes: 37 additions & 0 deletions examples/v2/csm-ownership/CreateOwnershipFeedback.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
"""
Submit feedback on an ownership inference returns "Created" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.csm_ownership_api import CSMOwnershipApi
from datadog_api_client.v2.model.ownership_feedback_action import OwnershipFeedbackAction
from datadog_api_client.v2.model.ownership_feedback_request import OwnershipFeedbackRequest
from datadog_api_client.v2.model.ownership_feedback_request_attributes import OwnershipFeedbackRequestAttributes
from datadog_api_client.v2.model.ownership_feedback_request_data import OwnershipFeedbackRequestData
from datadog_api_client.v2.model.ownership_feedback_type import OwnershipFeedbackType
from datadog_api_client.v2.model.ownership_owner_type import OwnershipOwnerType

body = OwnershipFeedbackRequest(
data=OwnershipFeedbackRequestData(
attributes=OwnershipFeedbackRequestAttributes(
action=OwnershipFeedbackAction.CONFIRM,
actor_handle="user@example.com",
actor_type="user",
corrected_owner_handle="team-b",
corrected_owner_type="team",
inference_checksum="abc123",
reason="Confirmed by team lead.",
),
type=OwnershipFeedbackType.OWNERSHIP_FEEDBACK,
),
)

configuration = Configuration()
configuration.unstable_operations["create_ownership_feedback"] = True
with ApiClient(configuration) as api_client:
api_instance = CSMOwnershipApi(api_client)
response = api_instance.create_ownership_feedback(
resource_id="res-1", owner_type=OwnershipOwnerType.TEAM, body=body
)

print(response)
18 changes: 18 additions & 0 deletions examples/v2/csm-ownership/GetOwnershipEvidence.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
"""
Get the evidence for an ownership inference returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.csm_ownership_api import CSMOwnershipApi
from datadog_api_client.v2.model.ownership_owner_type import OwnershipOwnerType

configuration = Configuration()
configuration.unstable_operations["get_ownership_evidence"] = True
with ApiClient(configuration) as api_client:
api_instance = CSMOwnershipApi(api_client)
response = api_instance.get_ownership_evidence(
resource_id="test-resource",
owner_type=OwnershipOwnerType.TEAM,
)

print(response)
18 changes: 18 additions & 0 deletions examples/v2/csm-ownership/GetOwnershipInference.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
"""
Get an ownership inference by owner type returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.csm_ownership_api import CSMOwnershipApi
from datadog_api_client.v2.model.ownership_owner_type import OwnershipOwnerType

configuration = Configuration()
configuration.unstable_operations["get_ownership_inference"] = True
with ApiClient(configuration) as api_client:
api_instance = CSMOwnershipApi(api_client)
response = api_instance.get_ownership_inference(
resource_id="test-resource",
owner_type=OwnershipOwnerType.TEAM,
)

print(response)
16 changes: 16 additions & 0 deletions examples/v2/csm-ownership/ListOwnershipHistory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
List ownership inference history for a resource returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.csm_ownership_api import CSMOwnershipApi

configuration = Configuration()
configuration.unstable_operations["list_ownership_history"] = True
with ApiClient(configuration) as api_client:
api_instance = CSMOwnershipApi(api_client)
response = api_instance.list_ownership_history(
resource_id="res-1",
)

print(response)
18 changes: 18 additions & 0 deletions examples/v2/csm-ownership/ListOwnershipHistoryByOwnerType.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
"""
List ownership history by owner type returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.csm_ownership_api import CSMOwnershipApi
from datadog_api_client.v2.model.ownership_owner_type import OwnershipOwnerType

configuration = Configuration()
configuration.unstable_operations["list_ownership_history_by_owner_type"] = True
with ApiClient(configuration) as api_client:
api_instance = CSMOwnershipApi(api_client)
response = api_instance.list_ownership_history_by_owner_type(
resource_id="res-1",
owner_type=OwnershipOwnerType.TEAM,
)

print(response)
16 changes: 16 additions & 0 deletions examples/v2/csm-ownership/ListOwnershipInferences.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
List ownership inferences for a resource returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.csm_ownership_api import CSMOwnershipApi

configuration = Configuration()
configuration.unstable_operations["list_ownership_inferences"] = True
with ApiClient(configuration) as api_client:
api_instance = CSMOwnershipApi(api_client)
response = api_instance.list_ownership_inferences(
resource_id="test-resource",
)

print(response)
6 changes: 6 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 @@ -464,6 +464,12 @@ def __init__(
"v2.list_cost_tag_metadata_months": False,
"v2.list_cost_tag_metadata_orchestrators": False,
"v2.search_cost_recommendations": False,
"v2.create_ownership_feedback": False,
"v2.get_ownership_evidence": False,
"v2.get_ownership_inference": False,
"v2.list_ownership_history": False,
"v2.list_ownership_history_by_owner_type": False,
"v2.list_ownership_inferences": False,
"v2.get_csm_agentless_host_facet_info": False,
"v2.get_csm_unified_host_facet_info": False,
"v2.list_csm_agentless_host_facets": False,
Expand Down
Loading
Loading