Skip to content

Add OpenAPI documentation for catalog-http service endpoints #3145

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 catalog-http service endpoints #3145

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

Large diffs are not rendered by default.

77 changes: 77 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 @@ -4,6 +4,13 @@ datadog\_api\_client.v2.model package
Submodules
----------

datadog\_api\_client.v2.model.accept\_recommended\_entities\_response module
----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.account\_filtering\_config module
---------------------------------------------------------------

Expand Down Expand Up @@ -11827,6 +11834,62 @@ datadog\_api\_client.v2.model.httpci\_app\_errors module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.idp\_config\_attributes module
------------------------------------------------------------

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

datadog\_api\_client.v2.model.idp\_config\_data module
------------------------------------------------------

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

datadog\_api\_client.v2.model.idp\_config\_request module
---------------------------------------------------------

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

datadog\_api\_client.v2.model.idp\_config\_request\_attributes module
---------------------------------------------------------------------

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

datadog\_api\_client.v2.model.idp\_config\_request\_data module
---------------------------------------------------------------

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

datadog\_api\_client.v2.model.idp\_config\_response module
----------------------------------------------------------

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

datadog\_api\_client.v2.model.idp\_config\_type module
------------------------------------------------------

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

datadog\_api\_client.v2.model.idp\_config\_value\_item module
-------------------------------------------------------------

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

datadog\_api\_client.v2.model.idp\_metadata\_form\_data module
--------------------------------------------------------------

Expand Down Expand Up @@ -20136,6 +20199,20 @@ datadog\_api\_client.v2.model.recommendation\_type module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.recommended\_entity\_id module
------------------------------------------------------------

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

datadog\_api\_client.v2.model.recommended\_entity\_with\_schema module
----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.reference\_table\_create\_source\_type module
---------------------------------------------------------------------------

Expand Down
102 changes: 102 additions & 0 deletions examples/v2/software-catalog/AcceptRecommendedEntities.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
"""
Accept recommended entities in bulk returns "Accepted" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.software_catalog_api import SoftwareCatalogApi
from datadog_api_client.v2.model.entity_v3_api_version import EntityV3APIVersion
from datadog_api_client.v2.model.entity_v3_datadog_code_location_item import EntityV3DatadogCodeLocationItem
from datadog_api_client.v2.model.entity_v3_datadog_event_item import EntityV3DatadogEventItem
from datadog_api_client.v2.model.entity_v3_datadog_integration_opsgenie import EntityV3DatadogIntegrationOpsgenie
from datadog_api_client.v2.model.entity_v3_datadog_integration_pagerduty import EntityV3DatadogIntegrationPagerduty
from datadog_api_client.v2.model.entity_v3_datadog_log_item import EntityV3DatadogLogItem
from datadog_api_client.v2.model.entity_v3_datadog_performance import EntityV3DatadogPerformance
from datadog_api_client.v2.model.entity_v3_datadog_pipelines import EntityV3DatadogPipelines
from datadog_api_client.v2.model.entity_v3_integrations import EntityV3Integrations
from datadog_api_client.v2.model.entity_v3_metadata import EntityV3Metadata
from datadog_api_client.v2.model.entity_v3_metadata_additional_owners_items import EntityV3MetadataAdditionalOwnersItems
from datadog_api_client.v2.model.entity_v3_metadata_contacts_items import EntityV3MetadataContactsItems
from datadog_api_client.v2.model.entity_v3_metadata_links_items import EntityV3MetadataLinksItems
from datadog_api_client.v2.model.entity_v3_service import EntityV3Service
from datadog_api_client.v2.model.entity_v3_service_datadog import EntityV3ServiceDatadog
from datadog_api_client.v2.model.entity_v3_service_kind import EntityV3ServiceKind
from datadog_api_client.v2.model.entity_v3_service_spec import EntityV3ServiceSpec
from datadog_api_client.v2.model.recommended_entity_with_schema import RecommendedEntityWithSchema

body = [
RecommendedEntityWithSchema(
id="123abc456def",
schema=EntityV3Service(
api_version=EntityV3APIVersion.V3,
datadog=EntityV3ServiceDatadog(
code_locations=[
EntityV3DatadogCodeLocationItem(
paths=[],
),
],
events=[
EntityV3DatadogEventItem(),
],
logs=[
EntityV3DatadogLogItem(),
],
performance_data=EntityV3DatadogPerformance(
tags=[],
),
pipelines=EntityV3DatadogPipelines(
fingerprints=[],
),
),
integrations=EntityV3Integrations(
opsgenie=EntityV3DatadogIntegrationOpsgenie(
service_url="https://www.opsgenie.com/service/shopping-cart",
),
pagerduty=EntityV3DatadogIntegrationPagerduty(
service_url="https://www.pagerduty.com/service-directory/Pshopping-cart",
),
),
kind=EntityV3ServiceKind.SERVICE,
metadata=EntityV3Metadata(
additional_owners=[
EntityV3MetadataAdditionalOwnersItems(
name="",
),
],
contacts=[
EntityV3MetadataContactsItems(
contact="https://slack/",
type="slack",
),
],
id="4b163705-23c0-4573-b2fb-f6cea2163fcb",
inherit_from="application:default/myapp",
links=[
EntityV3MetadataLinksItems(
name="mylink",
type="link",
url="https://mylink",
),
],
name="myService",
namespace="default",
tags=[
"this:tag",
"that:tag",
],
),
spec=EntityV3ServiceSpec(
component_of=[],
depends_on=[],
languages=[],
),
),
),
]

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

print(response)
97 changes: 97 additions & 0 deletions examples/v2/software-catalog/ConvertCatalogEntities.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
"""
Convert entities between schema versions returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.software_catalog_api import SoftwareCatalogApi
from datadog_api_client.v2.model.entity_schema_version import EntitySchemaVersion
from datadog_api_client.v2.model.entity_v3_api_version import EntityV3APIVersion
from datadog_api_client.v2.model.entity_v3_datadog_code_location_item import EntityV3DatadogCodeLocationItem
from datadog_api_client.v2.model.entity_v3_datadog_event_item import EntityV3DatadogEventItem
from datadog_api_client.v2.model.entity_v3_datadog_integration_opsgenie import EntityV3DatadogIntegrationOpsgenie
from datadog_api_client.v2.model.entity_v3_datadog_integration_pagerduty import EntityV3DatadogIntegrationPagerduty
from datadog_api_client.v2.model.entity_v3_datadog_log_item import EntityV3DatadogLogItem
from datadog_api_client.v2.model.entity_v3_datadog_performance import EntityV3DatadogPerformance
from datadog_api_client.v2.model.entity_v3_datadog_pipelines import EntityV3DatadogPipelines
from datadog_api_client.v2.model.entity_v3_integrations import EntityV3Integrations
from datadog_api_client.v2.model.entity_v3_metadata import EntityV3Metadata
from datadog_api_client.v2.model.entity_v3_metadata_additional_owners_items import EntityV3MetadataAdditionalOwnersItems
from datadog_api_client.v2.model.entity_v3_metadata_contacts_items import EntityV3MetadataContactsItems
from datadog_api_client.v2.model.entity_v3_metadata_links_items import EntityV3MetadataLinksItems
from datadog_api_client.v2.model.entity_v3_service import EntityV3Service
from datadog_api_client.v2.model.entity_v3_service_datadog import EntityV3ServiceDatadog
from datadog_api_client.v2.model.entity_v3_service_kind import EntityV3ServiceKind
from datadog_api_client.v2.model.entity_v3_service_spec import EntityV3ServiceSpec

body = EntityV3Service(
api_version=EntityV3APIVersion.V3,
datadog=EntityV3ServiceDatadog(
code_locations=[
EntityV3DatadogCodeLocationItem(
paths=[],
),
],
events=[
EntityV3DatadogEventItem(),
],
logs=[
EntityV3DatadogLogItem(),
],
performance_data=EntityV3DatadogPerformance(
tags=[],
),
pipelines=EntityV3DatadogPipelines(
fingerprints=[],
),
),
integrations=EntityV3Integrations(
opsgenie=EntityV3DatadogIntegrationOpsgenie(
service_url="https://www.opsgenie.com/service/shopping-cart",
),
pagerduty=EntityV3DatadogIntegrationPagerduty(
service_url="https://www.pagerduty.com/service-directory/Pshopping-cart",
),
),
kind=EntityV3ServiceKind.SERVICE,
metadata=EntityV3Metadata(
additional_owners=[
EntityV3MetadataAdditionalOwnersItems(
name="",
),
],
contacts=[
EntityV3MetadataContactsItems(
contact="https://slack/",
type="slack",
),
],
id="4b163705-23c0-4573-b2fb-f6cea2163fcb",
inherit_from="application:default/myapp",
links=[
EntityV3MetadataLinksItems(
name="mylink",
type="link",
url="https://mylink",
),
],
name="myService",
namespace="default",
tags=[
"this:tag",
"that:tag",
],
),
spec=EntityV3ServiceSpec(
component_of=[],
depends_on=[],
languages=[],
),
)

configuration = Configuration()
configuration.unstable_operations["convert_catalog_entities"] = True
with ApiClient(configuration) as api_client:
api_instance = SoftwareCatalogApi(api_client)
response = api_instance.convert_catalog_entities(target_version=EntitySchemaVersion.V3, body=body)

print(response)
19 changes: 19 additions & 0 deletions examples/v2/software-catalog/DeclineRecommendedEntities.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
"""
Decline recommended entities in bulk returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.software_catalog_api import SoftwareCatalogApi
from datadog_api_client.v2.model.recommended_entity_id import RecommendedEntityID

body = [
RecommendedEntityID(
id="123abcdef",
),
]

configuration = Configuration()
configuration.unstable_operations["decline_recommended_entities"] = True
with ApiClient(configuration) as api_client:
api_instance = SoftwareCatalogApi(api_client)
api_instance.decline_recommended_entities(body=body)
16 changes: 16 additions & 0 deletions examples/v2/software-catalog/GetIDPConfigValue.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Get Internal Developer Portal configuration returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.software_catalog_api import SoftwareCatalogApi

configuration = Configuration()
configuration.unstable_operations["get_idp_config_value"] = True
with ApiClient(configuration) as api_client:
api_instance = SoftwareCatalogApi(api_client)
response = api_instance.get_idp_config_value(
config_name="idp_pinned_dashboards",
)

print(response)
14 changes: 14 additions & 0 deletions examples/v2/software-catalog/TriggerRecommendedEntities.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"""
Trigger recommended entity discovery returns "Accepted" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.software_catalog_api import SoftwareCatalogApi

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

print(response)
28 changes: 28 additions & 0 deletions examples/v2/software-catalog/UpsertIDPConfigValue.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
"""
Create or update IDP configuration returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.software_catalog_api import SoftwareCatalogApi
from datadog_api_client.v2.model.idp_config_request import IDPConfigRequest
from datadog_api_client.v2.model.idp_config_request_attributes import IDPConfigRequestAttributes
from datadog_api_client.v2.model.idp_config_request_data import IDPConfigRequestData
from datadog_api_client.v2.model.idp_config_type import IDPConfigType
from datadog_api_client.v2.model.idp_config_value_item import IDPConfigValueItem

body = IDPConfigRequest(
data=IDPConfigRequestData(
attributes=IDPConfigRequestAttributes(
value=[
IDPConfigValueItem([("displayName", "My Dashboard"), ("id", "dashboard-1")]),
],
),
type=IDPConfigType.IDP_CONFIG,
),
)

configuration = Configuration()
configuration.unstable_operations["upsert_idp_config_value"] = True
with ApiClient(configuration) as api_client:
api_instance = SoftwareCatalogApi(api_client)
api_instance.upsert_idp_config_value(config_name="idp_pinned_dashboards", body=body)
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 @@ -266,6 +266,12 @@ def __init__(
"v2.get_open_api": False,
"v2.list_apis": False,
"v2.update_open_api": False,
"v2.accept_recommended_entities": False,
"v2.convert_catalog_entities": False,
"v2.decline_recommended_entities": False,
"v2.get_idp_config_value": False,
"v2.trigger_recommended_entities": False,
"v2.upsert_idp_config_value": False,
"v2.cancel_threat_hunting_job": False,
"v2.convert_job_result_to_signal": False,
"v2.delete_threat_hunting_job": False,
Expand Down
Loading
Loading