Skip to content

Add OpenAPI documentation for On Prem Management Service endpoints #2980

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 #2980

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.

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

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.create_on_prem_management_service_enrollment".to_sym] = true
end
api_instance = DatadogAPIClient::V2::OnPremManagementServiceAPI.new

body = DatadogAPIClient::V2::OnPremManagementServiceCreateEnrollmentRequest.new({
data: DatadogAPIClient::V2::OnPremManagementServiceEnrollmentDataRequest.new({
attributes: DatadogAPIClient::V2::OnPremManagementServiceEnrollmentAttributes.new({
actions_allowlist: [
"com.datadoghq.jenkins.*",
],
runner_host: "runner.example.com",
runner_modes: [
DatadogAPIClient::V2::OnPremManagementServiceEnrollmentAttributesRunnerModesItems::WORKFLOW_AUTOMATION,
],
runner_name: "my-runner",
}),
type: DatadogAPIClient::V2::OnPremManagementServiceEnrollmentType::ENROLLMENT,
}),
})
p api_instance.create_on_prem_management_service_enrollment(body)
8 changes: 8 additions & 0 deletions examples/v2/on-prem-management-service/GetOnPremManagementServiceEnrollment.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Get enrollment status returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.get_on_prem_management_service_enrollment".to_sym] = true
end
api_instance = DatadogAPIClient::V2::OnPremManagementServiceAPI.new
p api_instance.get_on_prem_management_service_enrollment("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
21 changes: 21 additions & 0 deletions examples/v2/on-prem-management-service/RegisterOnPremManagementServiceToken.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Register a token returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.register_on_prem_management_service_token".to_sym] = true
end
api_instance = DatadogAPIClient::V2::OnPremManagementServiceAPI.new

body = DatadogAPIClient::V2::OnPremManagementServiceRegisterTokenRequest.new({
data: DatadogAPIClient::V2::OnPremManagementServiceRegisterTokenDataRequest.new({
attributes: DatadogAPIClient::V2::OnPremManagementServiceRegisterTokenAttributes.new({
app_id: "9a93d314-ca37-461d-b18e-0587f03c6e2a",
app_version: 5,
connection_id: "2f66ec56-d1f3-4a18-908d-5e8c12dfb3b0",
query_id: "8744d459-18aa-405b-821e-df9bb101c01e",
runner_id: "runner-GBUyh2Tm6oKS6ap4kt8Bbx",
}),
type: DatadogAPIClient::V2::OnPremManagementServiceRegisterTokenType::REGISTERTOKENREQUEST,
}),
})
p api_instance.register_on_prem_management_service_token(body)
9 changes: 9 additions & 0 deletions features/scenarios_model_mapping.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2893,6 +2893,15 @@
"v2.ResolveOnCallPage" => {
"page_id" => "UUID",
},
"v2.CreateOnPremManagementServiceEnrollment" => {
"body" => "OnPremManagementServiceCreateEnrollmentRequest",
},
"v2.GetOnPremManagementServiceEnrollment" => {
"token_hash" => "String",
},
"v2.RegisterOnPremManagementServiceToken" => {
"body" => "OnPremManagementServiceRegisterTokenRequest",
},
"v2.GetOrgConfig" => {
"org_config_name" => "String",
},
Expand Down
74 changes: 74 additions & 0 deletions features/v2/on-prem_management_service.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
@endpoint(on-prem-management-service) @endpoint(on-prem-management-service-v2)
Feature: On-Prem Management Service
Manage on-premises runners for workflow automation and app builder. Use
these endpoints to enroll runners, check enrollment status, and register
tokens for query execution.

Background:
Given a valid "apiKeyAuth" key in the system
And a valid "appKeyAuth" key in the system
And an instance of "OnPremManagementService" API

@generated @skip @team:DataDog/action-platform
Scenario: Create an enrollment returns "Bad Request" response
Given operation "CreateOnPremManagementServiceEnrollment" enabled
And new "CreateOnPremManagementServiceEnrollment" request
And body with value {"data": {"attributes": {"actions_allowlist": ["com.datadoghq.jenkins.*"], "runner_host": "runner.example.com", "runner_modes": ["workflow_automation"], "runner_name": "my-runner"}, "type": "enrollment"}}
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/action-platform
Scenario: Create an enrollment returns "Created" response
Given operation "CreateOnPremManagementServiceEnrollment" enabled
And new "CreateOnPremManagementServiceEnrollment" request
And body with value {"data": {"attributes": {"actions_allowlist": ["com.datadoghq.jenkins.*"], "runner_host": "runner.example.com", "runner_modes": ["workflow_automation"], "runner_name": "my-runner"}, "type": "enrollment"}}
When the request is sent
Then the response status is 201 Created

@generated @skip @team:DataDog/action-platform
Scenario: Get enrollment status returns "Bad Request" response
Given operation "GetOnPremManagementServiceEnrollment" enabled
And new "GetOnPremManagementServiceEnrollment" request
And request contains "token_hash" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/action-platform
Scenario: Get enrollment status returns "Not Found" response
Given operation "GetOnPremManagementServiceEnrollment" enabled
And new "GetOnPremManagementServiceEnrollment" request
And request contains "token_hash" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/action-platform
Scenario: Get enrollment status returns "OK" response
Given operation "GetOnPremManagementServiceEnrollment" enabled
And new "GetOnPremManagementServiceEnrollment" request
And request contains "token_hash" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/action-platform
Scenario: Register a token returns "Bad Request" response
Given operation "RegisterOnPremManagementServiceToken" enabled
And new "RegisterOnPremManagementServiceToken" request
And body with value {"data": {"attributes": {"app_id": "9a93d314-ca37-461d-b18e-0587f03c6e2a", "app_version": 5, "connection_id": "2f66ec56-d1f3-4a18-908d-5e8c12dfb3b0", "query_id": "8744d459-18aa-405b-821e-df9bb101c01e", "runner_id": "runner-GBUyh2Tm6oKS6ap4kt8Bbx"}, "type": "registerTokenRequest"}}
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/action-platform
Scenario: Register a token returns "Not Found" response
Given operation "RegisterOnPremManagementServiceToken" enabled
And new "RegisterOnPremManagementServiceToken" request
And body with value {"data": {"attributes": {"app_id": "9a93d314-ca37-461d-b18e-0587f03c6e2a", "app_version": 5, "connection_id": "2f66ec56-d1f3-4a18-908d-5e8c12dfb3b0", "query_id": "8744d459-18aa-405b-821e-df9bb101c01e", "runner_id": "runner-GBUyh2Tm6oKS6ap4kt8Bbx"}, "type": "registerTokenRequest"}}
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/action-platform
Scenario: Register a token returns "OK" response
Given operation "RegisterOnPremManagementServiceToken" enabled
And new "RegisterOnPremManagementServiceToken" request
And body with value {"data": {"attributes": {"app_id": "9a93d314-ca37-461d-b18e-0587f03c6e2a", "app_version": 5, "connection_id": "2f66ec56-d1f3-4a18-908d-5e8c12dfb3b0", "query_id": "8744d459-18aa-405b-821e-df9bb101c01e", "runner_id": "runner-GBUyh2Tm6oKS6ap4kt8Bbx"}, "type": "registerTokenRequest"}}
When the request is sent
Then the response status is 200 OK
74 changes: 74 additions & 0 deletions features/v2/on_prem_management_service.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
@endpoint(on-prem-management-service) @endpoint(on-prem-management-service-v2)
Feature: On Prem Management Service
Manage on-premises runners for workflow automation and app builder. Use
these endpoints to enroll runners, check enrollment status, and register
tokens for query execution.

Background:
Given a valid "apiKeyAuth" key in the system
And a valid "appKeyAuth" key in the system
And an instance of "OnPremManagementService" API

@generated @skip @team:DataDog/action-platform
Scenario: Create an enrollment returns "Bad Request" response
Given operation "CreateOnPremManagementServiceEnrollment" enabled
And new "CreateOnPremManagementServiceEnrollment" request
And body with value {"data": {"attributes": {"actions_allowlist": ["com.datadoghq.jenkins.*"], "runner_host": "runner.example.com", "runner_modes": ["workflow_automation"], "runner_name": "my-runner"}, "type": "enrollment"}}
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/action-platform
Scenario: Create an enrollment returns "Created" response
Given operation "CreateOnPremManagementServiceEnrollment" enabled
And new "CreateOnPremManagementServiceEnrollment" request
And body with value {"data": {"attributes": {"actions_allowlist": ["com.datadoghq.jenkins.*"], "runner_host": "runner.example.com", "runner_modes": ["workflow_automation"], "runner_name": "my-runner"}, "type": "enrollment"}}
When the request is sent
Then the response status is 201 Created

@generated @skip @team:DataDog/action-platform
Scenario: Get enrollment status returns "Bad Request" response
Given operation "GetOnPremManagementServiceEnrollment" enabled
And new "GetOnPremManagementServiceEnrollment" request
And request contains "token_hash" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/action-platform
Scenario: Get enrollment status returns "Not Found" response
Given operation "GetOnPremManagementServiceEnrollment" enabled
And new "GetOnPremManagementServiceEnrollment" request
And request contains "token_hash" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/action-platform
Scenario: Get enrollment status returns "OK" response
Given operation "GetOnPremManagementServiceEnrollment" enabled
And new "GetOnPremManagementServiceEnrollment" request
And request contains "token_hash" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/action-platform
Scenario: Register a token returns "Bad Request" response
Given operation "RegisterOnPremManagementServiceToken" enabled
And new "RegisterOnPremManagementServiceToken" request
And body with value {"data": {"attributes": {"app_id": "9a93d314-ca37-461d-b18e-0587f03c6e2a", "app_version": 5, "connection_id": "2f66ec56-d1f3-4a18-908d-5e8c12dfb3b0", "query_id": "8744d459-18aa-405b-821e-df9bb101c01e", "runner_id": "runner-GBUyh2Tm6oKS6ap4kt8Bbx"}, "type": "registerTokenRequest"}}
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/action-platform
Scenario: Register a token returns "Not Found" response
Given operation "RegisterOnPremManagementServiceToken" enabled
And new "RegisterOnPremManagementServiceToken" request
And body with value {"data": {"attributes": {"app_id": "9a93d314-ca37-461d-b18e-0587f03c6e2a", "app_version": 5, "connection_id": "2f66ec56-d1f3-4a18-908d-5e8c12dfb3b0", "query_id": "8744d459-18aa-405b-821e-df9bb101c01e", "runner_id": "runner-GBUyh2Tm6oKS6ap4kt8Bbx"}, "type": "registerTokenRequest"}}
When the request is sent
Then the response status is 404 Not Found

@generated @skip @team:DataDog/action-platform
Scenario: Register a token returns "OK" response
Given operation "RegisterOnPremManagementServiceToken" enabled
And new "RegisterOnPremManagementServiceToken" request
And body with value {"data": {"attributes": {"app_id": "9a93d314-ca37-461d-b18e-0587f03c6e2a", "app_version": 5, "connection_id": "2f66ec56-d1f3-4a18-908d-5e8c12dfb3b0", "query_id": "8744d459-18aa-405b-821e-df9bb101c01e", "runner_id": "runner-GBUyh2Tm6oKS6ap4kt8Bbx"}, "type": "registerTokenRequest"}}
When the request is sent
Then the response status is 200 OK
22 changes: 22 additions & 0 deletions features/v2/undo.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3332,6 +3332,28 @@
"type": "safe"
}
},
"CreateOnPremManagementServiceEnrollment": {
"tag": "On Prem Management Service",
"undo": {
"operationId": "TODO",
"parameters": [],
"type": "unsafe"
}
},
"GetOnPremManagementServiceEnrollment": {
"tag": "On Prem Management Service",
"undo": {
"type": "safe"
}
},
"RegisterOnPremManagementServiceToken": {
"tag": "On Prem Management Service",
"undo": {
"operationId": "TODO",
"parameters": [],
"type": "unsafe"
}
},
"ListOrgConfigs": {
"tag": "Organizations",
"undo": {
Expand Down
3 changes: 3 additions & 0 deletions lib/datadog_api_client/configuration.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,9 @@ def initialize
"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
23 changes: 23 additions & 0 deletions lib/datadog_api_client/inflector.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3634,6 +3634,28 @@ def overrides
"v2.on_demand_concurrency_cap_attributes" => "OnDemandConcurrencyCapAttributes",
"v2.on_demand_concurrency_cap_response" => "OnDemandConcurrencyCapResponse",
"v2.on_demand_concurrency_cap_type" => "OnDemandConcurrencyCapType",
"v2.on_prem_management_service_create_enrollment_request" => "OnPremManagementServiceCreateEnrollmentRequest",
"v2.on_prem_management_service_create_enrollment_response" => "OnPremManagementServiceCreateEnrollmentResponse",
"v2.on_prem_management_service_create_enrollment_response_attributes" => "OnPremManagementServiceCreateEnrollmentResponseAttributes",
"v2.on_prem_management_service_create_enrollment_response_data" => "OnPremManagementServiceCreateEnrollmentResponseData",
"v2.on_prem_management_service_create_enrollment_response_type" => "OnPremManagementServiceCreateEnrollmentResponseType",
"v2.on_prem_management_service_enrollment_attributes" => "OnPremManagementServiceEnrollmentAttributes",
"v2.on_prem_management_service_enrollment_attributes_runner_modes_items" => "OnPremManagementServiceEnrollmentAttributesRunnerModesItems",
"v2.on_prem_management_service_enrollment_data_request" => "OnPremManagementServiceEnrollmentDataRequest",
"v2.on_prem_management_service_enrollment_type" => "OnPremManagementServiceEnrollmentType",
"v2.on_prem_management_service_get_enrollment_response" => "OnPremManagementServiceGetEnrollmentResponse",
"v2.on_prem_management_service_get_enrollment_response_attributes" => "OnPremManagementServiceGetEnrollmentResponseAttributes",
"v2.on_prem_management_service_get_enrollment_response_attributes_status" => "OnPremManagementServiceGetEnrollmentResponseAttributesStatus",
"v2.on_prem_management_service_get_enrollment_response_data" => "OnPremManagementServiceGetEnrollmentResponseData",
"v2.on_prem_management_service_get_enrollment_response_type" => "OnPremManagementServiceGetEnrollmentResponseType",
"v2.on_prem_management_service_register_token_attributes" => "OnPremManagementServiceRegisterTokenAttributes",
"v2.on_prem_management_service_register_token_data_request" => "OnPremManagementServiceRegisterTokenDataRequest",
"v2.on_prem_management_service_register_token_request" => "OnPremManagementServiceRegisterTokenRequest",
"v2.on_prem_management_service_register_token_response" => "OnPremManagementServiceRegisterTokenResponse",
"v2.on_prem_management_service_register_token_response_attributes" => "OnPremManagementServiceRegisterTokenResponseAttributes",
"v2.on_prem_management_service_register_token_response_data" => "OnPremManagementServiceRegisterTokenResponseData",
"v2.on_prem_management_service_register_token_response_type" => "OnPremManagementServiceRegisterTokenResponseType",
"v2.on_prem_management_service_register_token_type" => "OnPremManagementServiceRegisterTokenType",
"v2.open_aiapi_key" => "OpenAIAPIKey",
"v2.open_aiapi_key_type" => "OpenAIAPIKeyType",
"v2.open_aiapi_key_update" => "OpenAIAPIKeyUpdate",
Expand Down Expand Up @@ -5283,6 +5305,7 @@ def overrides
"v2.observability_pipelines_api" => "ObservabilityPipelinesAPI",
"v2.oci_integration_api" => "OCIIntegrationAPI",
"v2.okta_integration_api" => "OktaIntegrationAPI",
"v2.on_prem_management_service_api" => "OnPremManagementServiceAPI",
"v2.on_call_api" => "OnCallAPI",
"v2.on_call_paging_api" => "OnCallPagingAPI",
"v2.opsgenie_integration_api" => "OpsgenieIntegrationAPI",
Expand Down
Loading
Loading