Skip to content

Add OpenAPI documentation for On Prem Management Service endpoints #3460

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

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.

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

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.OnPremManagementServiceApi;
import com.datadog.api.client.v2.model.OnPremManagementServiceCreateEnrollmentRequest;
import com.datadog.api.client.v2.model.OnPremManagementServiceCreateEnrollmentResponse;
import com.datadog.api.client.v2.model.OnPremManagementServiceEnrollmentAttributes;
import com.datadog.api.client.v2.model.OnPremManagementServiceEnrollmentAttributesRunnerModesItems;
import com.datadog.api.client.v2.model.OnPremManagementServiceEnrollmentDataRequest;
import com.datadog.api.client.v2.model.OnPremManagementServiceEnrollmentType;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.createOnPremManagementServiceEnrollment", true);
OnPremManagementServiceApi apiInstance = new OnPremManagementServiceApi(defaultClient);

OnPremManagementServiceCreateEnrollmentRequest body =
new OnPremManagementServiceCreateEnrollmentRequest()
.data(
new OnPremManagementServiceEnrollmentDataRequest()
.attributes(
new OnPremManagementServiceEnrollmentAttributes()
.actionsAllowlist(Collections.singletonList("com.datadoghq.jenkins.*"))
.runnerHost("runner.example.com")
.runnerModes(
Collections.singletonList(
OnPremManagementServiceEnrollmentAttributesRunnerModesItems
.WORKFLOW_AUTOMATION))
.runnerName("my-runner"))
.type(OnPremManagementServiceEnrollmentType.ENROLLMENT));

try {
OnPremManagementServiceCreateEnrollmentResponse result =
apiInstance.createOnPremManagementServiceEnrollment(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling"
+ " OnPremManagementServiceApi#createOnPremManagementServiceEnrollment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
28 changes: 28 additions & 0 deletions examples/v2/on-prem-management-service/GetOnPremManagementServiceEnrollment.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
// Get enrollment status returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.OnPremManagementServiceApi;
import com.datadog.api.client.v2.model.OnPremManagementServiceGetEnrollmentResponse;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.getOnPremManagementServiceEnrollment", true);
OnPremManagementServiceApi apiInstance = new OnPremManagementServiceApi(defaultClient);

try {
OnPremManagementServiceGetEnrollmentResponse result =
apiInstance.getOnPremManagementServiceEnrollment(
"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling OnPremManagementServiceApi#getOnPremManagementServiceEnrollment");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
45 changes: 45 additions & 0 deletions examples/v2/on-prem-management-service/RegisterOnPremManagementServiceToken.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
// Register a token returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.OnPremManagementServiceApi;
import com.datadog.api.client.v2.model.OnPremManagementServiceRegisterTokenAttributes;
import com.datadog.api.client.v2.model.OnPremManagementServiceRegisterTokenDataRequest;
import com.datadog.api.client.v2.model.OnPremManagementServiceRegisterTokenRequest;
import com.datadog.api.client.v2.model.OnPremManagementServiceRegisterTokenResponse;
import com.datadog.api.client.v2.model.OnPremManagementServiceRegisterTokenType;
import java.util.UUID;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setUnstableOperationEnabled("v2.registerOnPremManagementServiceToken", true);
OnPremManagementServiceApi apiInstance = new OnPremManagementServiceApi(defaultClient);

OnPremManagementServiceRegisterTokenRequest body =
new OnPremManagementServiceRegisterTokenRequest()
.data(
new OnPremManagementServiceRegisterTokenDataRequest()
.attributes(
new OnPremManagementServiceRegisterTokenAttributes()
.appId(UUID.fromString("9a93d314-ca37-461d-b18e-0587f03c6e2a"))
.appVersion(5L)
.connectionId(UUID.fromString("2f66ec56-d1f3-4a18-908d-5e8c12dfb3b0"))
.queryId(UUID.fromString("8744d459-18aa-405b-821e-df9bb101c01e"))
.runnerId("runner-GBUyh2Tm6oKS6ap4kt8Bbx"))
.type(OnPremManagementServiceRegisterTokenType.REGISTERTOKENREQUEST));

try {
OnPremManagementServiceRegisterTokenResponse result =
apiInstance.registerOnPremManagementServiceToken(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
"Exception when calling OnPremManagementServiceApi#registerOnPremManagementServiceToken");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
3 changes: 3 additions & 0 deletions src/main/java/com/datadog/api/client/ApiClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -894,6 +894,9 @@ public class ApiClient {
put("v2.updateMonitorUserTemplate", false);
put("v2.validateExistingMonitorUserTemplate", false);
put("v2.validateMonitorUserTemplate", false);
put("v2.createOnPremManagementServiceEnrollment", false);
put("v2.getOnPremManagementServiceEnrollment", false);
put("v2.registerOnPremManagementServiceToken", false);
put("v2.listRoleTemplates", false);
put("v2.createConnection", false);
put("v2.deleteConnection", false);
Expand Down
Loading
Loading