Skip to content

Add OpenAPI documentation for On Prem Management Service endpoints #3158

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 On Prem Management Service endpoints #3158

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
451 changes: 451 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 @@ -424,6 +424,13 @@ datadog\_api\_client.v2.api.on\_call\_paging\_api module
:members:
:show-inheritance:

datadog\_api\_client.v2.api.on\_prem\_management\_service\_api module
---------------------------------------------------------------------

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

datadog\_api\_client.v2.api.opsgenie\_integration\_api module
-------------------------------------------------------------

Expand Down
154 changes: 154 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 @@ -18694,6 +18694,160 @@ datadog\_api\_client.v2.model.on\_demand\_concurrency\_cap\_type module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.on\_prem\_management\_service\_create\_enrollment\_request module
-----------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_create\_enrollment\_response module
------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_create\_enrollment\_response\_attributes module
------------------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_create\_enrollment\_response\_data module
------------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_create\_enrollment\_response\_type module
------------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_enrollment\_attributes module
------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_enrollment\_attributes\_runner\_modes\_items module
----------------------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_enrollment\_data\_request module
---------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_enrollment\_type module
------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_get\_enrollment\_response module
---------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_get\_enrollment\_response\_attributes module
---------------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_get\_enrollment\_response\_attributes\_status module
-----------------------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_get\_enrollment\_response\_data module
---------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_get\_enrollment\_response\_type module
---------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_register\_token\_attributes module
-----------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_register\_token\_data\_request module
--------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_register\_token\_request module
--------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_register\_token\_response module
---------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_register\_token\_response\_attributes module
---------------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_register\_token\_response\_data module
---------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_register\_token\_response\_type module
---------------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.on\_prem\_management\_service\_register\_token\_type module
-----------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.open\_ai\_credentials module
----------------------------------------------------------

Expand Down
43 changes: 43 additions & 0 deletions examples/v2/on-prem-management-service/CreateOnPremManagementServiceEnrollment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
"""
Create an enrollment returns "Created" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.on_prem_management_service_api import OnPremManagementServiceApi
from datadog_api_client.v2.model.on_prem_management_service_create_enrollment_request import (
OnPremManagementServiceCreateEnrollmentRequest,
)
from datadog_api_client.v2.model.on_prem_management_service_enrollment_attributes import (
OnPremManagementServiceEnrollmentAttributes,
)
from datadog_api_client.v2.model.on_prem_management_service_enrollment_attributes_runner_modes_items import (
OnPremManagementServiceEnrollmentAttributesRunnerModesItems,
)
from datadog_api_client.v2.model.on_prem_management_service_enrollment_data_request import (
OnPremManagementServiceEnrollmentDataRequest,
)
from datadog_api_client.v2.model.on_prem_management_service_enrollment_type import OnPremManagementServiceEnrollmentType

body = OnPremManagementServiceCreateEnrollmentRequest(
data=OnPremManagementServiceEnrollmentDataRequest(
attributes=OnPremManagementServiceEnrollmentAttributes(
actions_allowlist=[
"com.datadoghq.jenkins.*",
],
runner_host="runner.example.com",
runner_modes=[
OnPremManagementServiceEnrollmentAttributesRunnerModesItems.WORKFLOW_AUTOMATION,
],
runner_name="my-runner",
),
type=OnPremManagementServiceEnrollmentType.ENROLLMENT,
),
)

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

print(response)
16 changes: 16 additions & 0 deletions examples/v2/on-prem-management-service/GetOnPremManagementServiceEnrollment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Get enrollment status returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.on_prem_management_service_api import OnPremManagementServiceApi

configuration = Configuration()
configuration.unstable_operations["get_on_prem_management_service_enrollment"] = True
with ApiClient(configuration) as api_client:
api_instance = OnPremManagementServiceApi(api_client)
response = api_instance.get_on_prem_management_service_enrollment(
token_hash="aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
)

print(response)
40 changes: 40 additions & 0 deletions examples/v2/on-prem-management-service/RegisterOnPremManagementServiceToken.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
"""
Register a token returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.on_prem_management_service_api import OnPremManagementServiceApi
from datadog_api_client.v2.model.on_prem_management_service_register_token_attributes import (
OnPremManagementServiceRegisterTokenAttributes,
)
from datadog_api_client.v2.model.on_prem_management_service_register_token_data_request import (
OnPremManagementServiceRegisterTokenDataRequest,
)
from datadog_api_client.v2.model.on_prem_management_service_register_token_request import (
OnPremManagementServiceRegisterTokenRequest,
)
from datadog_api_client.v2.model.on_prem_management_service_register_token_type import (
OnPremManagementServiceRegisterTokenType,
)
from uuid import UUID

body = OnPremManagementServiceRegisterTokenRequest(
data=OnPremManagementServiceRegisterTokenDataRequest(
attributes=OnPremManagementServiceRegisterTokenAttributes(
app_id=UUID("9a93d314-ca37-461d-b18e-0587f03c6e2a"),
app_version=5,
connection_id=UUID("2f66ec56-d1f3-4a18-908d-5e8c12dfb3b0"),
query_id=UUID("8744d459-18aa-405b-821e-df9bb101c01e"),
runner_id="runner-GBUyh2Tm6oKS6ap4kt8Bbx",
),
type=OnPremManagementServiceRegisterTokenType.REGISTERTOKENREQUEST,
),
)

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

print(response)
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 @@ -385,6 +385,9 @@ def __init__(
"v2.update_monitor_user_template": False,
"v2.validate_existing_monitor_user_template": False,
"v2.validate_monitor_user_template": False,
"v2.create_on_prem_management_service_enrollment": False,
"v2.get_on_prem_management_service_enrollment": False,
"v2.register_on_prem_management_service_token": False,
"v2.list_role_templates": False,
"v2.create_connection": False,
"v2.delete_connection": False,
Expand Down
Loading