Add OpenAPI documentation for catalog-http service endpoints

examples/v2/software-catalog/AcceptRecommendedEntities.java

@@ -0,0 +1,99 @@
+// Accept recommended entities in bulk returns "Accepted" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.SoftwareCatalogApi;
+import com.datadog.api.client.v2.model.AcceptRecommendedEntitiesResponse;
+import com.datadog.api.client.v2.model.EntityV3;
+import com.datadog.api.client.v2.model.EntityV3APIVersion;
+import com.datadog.api.client.v2.model.EntityV3DatadogCodeLocationItem;
+import com.datadog.api.client.v2.model.EntityV3DatadogEventItem;
+import com.datadog.api.client.v2.model.EntityV3DatadogIntegrationOpsgenie;
+import com.datadog.api.client.v2.model.EntityV3DatadogIntegrationPagerduty;
+import com.datadog.api.client.v2.model.EntityV3DatadogLogItem;
+import com.datadog.api.client.v2.model.EntityV3DatadogPerformance;
+import com.datadog.api.client.v2.model.EntityV3DatadogPipelines;
+import com.datadog.api.client.v2.model.EntityV3Integrations;
+import com.datadog.api.client.v2.model.EntityV3Metadata;
+import com.datadog.api.client.v2.model.EntityV3MetadataAdditionalOwnersItems;
+import com.datadog.api.client.v2.model.EntityV3MetadataContactsItems;
+import com.datadog.api.client.v2.model.EntityV3MetadataLinksItems;
+import com.datadog.api.client.v2.model.EntityV3Service;
+import com.datadog.api.client.v2.model.EntityV3ServiceDatadog;
+import com.datadog.api.client.v2.model.EntityV3ServiceKind;
+import com.datadog.api.client.v2.model.EntityV3ServiceSpec;
+import com.datadog.api.client.v2.model.RecommendedEntityWithSchema;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setUnstableOperationEnabled("v2.acceptRecommendedEntities", true);
+    SoftwareCatalogApi apiInstance = new SoftwareCatalogApi(defaultClient);
+
+    List<RecommendedEntityWithSchema> body =
+        Collections.singletonList(
+            new RecommendedEntityWithSchema()
+                .id("123abc456def")
+                .schema(
+                    new EntityV3(
+                        new EntityV3Service()
+                            .apiVersion(EntityV3APIVersion.V3)
+                            .datadog(
+                                new EntityV3ServiceDatadog()
+                                    .codeLocations(
+                                        Collections.singletonList(
+                                            new EntityV3DatadogCodeLocationItem()))
+                                    .events(
+                                        Collections.singletonList(new EntityV3DatadogEventItem()))
+                                    .logs(Collections.singletonList(new EntityV3DatadogLogItem()))
+                                    .performanceData(new EntityV3DatadogPerformance())
+                                    .pipelines(new EntityV3DatadogPipelines()))
+                            .integrations(
+                                new EntityV3Integrations()
+                                    .opsgenie(
+                                        new EntityV3DatadogIntegrationOpsgenie()
+                                            .serviceUrl(
+                                                "https://www.opsgenie.com/service/shopping-cart"))
+                                    .pagerduty(
+                                        new EntityV3DatadogIntegrationPagerduty()
+                                            .serviceUrl(
+                                                "https://www.pagerduty.com/service-directory/Pshopping-cart")))
+                            .kind(EntityV3ServiceKind.SERVICE)
+                            .metadata(
+                                new EntityV3Metadata()
+                                    .additionalOwners(
+                                        Collections.singletonList(
+                                            new EntityV3MetadataAdditionalOwnersItems().name("")))
+                                    .contacts(
+                                        Collections.singletonList(
+                                            new EntityV3MetadataContactsItems()
+                                                .contact("https://slack/")
+                                                .type("slack")))
+                                    .id("4b163705-23c0-4573-b2fb-f6cea2163fcb")
+                                    .inheritFrom("application:default/myapp")
+                                    .links(
+                                        Collections.singletonList(
+                                            new EntityV3MetadataLinksItems()
+                                                .name("mylink")
+                                                .type("link")
+                                                .url("https://mylink")))
+                                    .name("myService")
+                                    .namespace("default")
+                                    .tags(Arrays.asList("this:tag", "that:tag")))
+                            .spec(new EntityV3ServiceSpec()))));
+
+    try {
+      AcceptRecommendedEntitiesResponse result = apiInstance.acceptRecommendedEntities(body);
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling SoftwareCatalogApi#acceptRecommendedEntities");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/software-catalog/ConvertCatalogEntities.java

@@ -0,0 +1,94 @@
+// Convert entities between schema versions returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.SoftwareCatalogApi;
+import com.datadog.api.client.v2.model.ConvertCatalogEntityResponse;
+import com.datadog.api.client.v2.model.EntitySchemaVersion;
+import com.datadog.api.client.v2.model.EntityV3;
+import com.datadog.api.client.v2.model.EntityV3APIVersion;
+import com.datadog.api.client.v2.model.EntityV3DatadogCodeLocationItem;
+import com.datadog.api.client.v2.model.EntityV3DatadogEventItem;
+import com.datadog.api.client.v2.model.EntityV3DatadogIntegrationOpsgenie;
+import com.datadog.api.client.v2.model.EntityV3DatadogIntegrationPagerduty;
+import com.datadog.api.client.v2.model.EntityV3DatadogLogItem;
+import com.datadog.api.client.v2.model.EntityV3DatadogPerformance;
+import com.datadog.api.client.v2.model.EntityV3DatadogPipelines;
+import com.datadog.api.client.v2.model.EntityV3Integrations;
+import com.datadog.api.client.v2.model.EntityV3Metadata;
+import com.datadog.api.client.v2.model.EntityV3MetadataAdditionalOwnersItems;
+import com.datadog.api.client.v2.model.EntityV3MetadataContactsItems;
+import com.datadog.api.client.v2.model.EntityV3MetadataLinksItems;
+import com.datadog.api.client.v2.model.EntityV3Service;
+import com.datadog.api.client.v2.model.EntityV3ServiceDatadog;
+import com.datadog.api.client.v2.model.EntityV3ServiceKind;
+import com.datadog.api.client.v2.model.EntityV3ServiceSpec;
+import com.datadog.api.client.v2.model.UpsertCatalogEntityRequest;
+import java.util.Arrays;
+import java.util.Collections;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setUnstableOperationEnabled("v2.convertCatalogEntities", true);
+    SoftwareCatalogApi apiInstance = new SoftwareCatalogApi(defaultClient);
+
+    UpsertCatalogEntityRequest body =
+        new UpsertCatalogEntityRequest(
+            new EntityV3(
+                new EntityV3Service()
+                    .apiVersion(EntityV3APIVersion.V3)
+                    .datadog(
+                        new EntityV3ServiceDatadog()
+                            .codeLocations(
+                                Collections.singletonList(new EntityV3DatadogCodeLocationItem()))
+                            .events(Collections.singletonList(new EntityV3DatadogEventItem()))
+                            .logs(Collections.singletonList(new EntityV3DatadogLogItem()))
+                            .performanceData(new EntityV3DatadogPerformance())
+                            .pipelines(new EntityV3DatadogPipelines()))
+                    .integrations(
+                        new EntityV3Integrations()
+                            .opsgenie(
+                                new EntityV3DatadogIntegrationOpsgenie()
+                                    .serviceUrl("https://www.opsgenie.com/service/shopping-cart"))
+                            .pagerduty(
+                                new EntityV3DatadogIntegrationPagerduty()
+                                    .serviceUrl(
+                                        "https://www.pagerduty.com/service-directory/Pshopping-cart")))
+                    .kind(EntityV3ServiceKind.SERVICE)
+                    .metadata(
+                        new EntityV3Metadata()
+                            .additionalOwners(
+                                Collections.singletonList(
+                                    new EntityV3MetadataAdditionalOwnersItems().name("")))
+                            .contacts(
+                                Collections.singletonList(
+                                    new EntityV3MetadataContactsItems()
+                                        .contact("https://slack/")
+                                        .type("slack")))
+                            .id("4b163705-23c0-4573-b2fb-f6cea2163fcb")
+                            .inheritFrom("application:default/myapp")
+                            .links(
+                                Collections.singletonList(
+                                    new EntityV3MetadataLinksItems()
+                                        .name("mylink")
+                                        .type("link")
+                                        .url("https://mylink")))
+                            .name("myService")
+                            .namespace("default")
+                            .tags(Arrays.asList("this:tag", "that:tag")))
+                    .spec(new EntityV3ServiceSpec())));
+
+    try {
+      ConvertCatalogEntityResponse result =
+          apiInstance.convertCatalogEntities(EntitySchemaVersion.V3, body);
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling SoftwareCatalogApi#convertCatalogEntities");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/software-catalog/DeclineRecommendedEntities.java

@@ -0,0 +1,29 @@
+// Decline recommended entities in bulk returns "No Content" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.SoftwareCatalogApi;
+import com.datadog.api.client.v2.model.RecommendedEntityID;
+import java.util.Collections;
+import java.util.List;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setUnstableOperationEnabled("v2.declineRecommendedEntities", true);
+    SoftwareCatalogApi apiInstance = new SoftwareCatalogApi(defaultClient);
+
+    List<RecommendedEntityID> body =
+        Collections.singletonList(new RecommendedEntityID().id("123abcdef"));
+
+    try {
+      apiInstance.declineRecommendedEntities(body);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling SoftwareCatalogApi#declineRecommendedEntities");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/software-catalog/GetIDPConfigValue.java

@@ -0,0 +1,25 @@
+// Get Internal Developer Portal configuration returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.SoftwareCatalogApi;
+import com.datadog.api.client.v2.model.IDPConfigResponse;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setUnstableOperationEnabled("v2.getIDPConfigValue", true);
+    SoftwareCatalogApi apiInstance = new SoftwareCatalogApi(defaultClient);
+
+    try {
+      IDPConfigResponse result = apiInstance.getIDPConfigValue("idp_pinned_dashboards");
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling SoftwareCatalogApi#getIDPConfigValue");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/software-catalog/TriggerRecommendedEntities.java

@@ -0,0 +1,23 @@
+// Trigger recommended entity discovery returns "Accepted" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.SoftwareCatalogApi;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setUnstableOperationEnabled("v2.triggerRecommendedEntities", true);
+    SoftwareCatalogApi apiInstance = new SoftwareCatalogApi(defaultClient);
+
+    try {
+      apiInstance.triggerRecommendedEntities();
+    } catch (ApiException e) {
+      System.err.println("Exception when calling SoftwareCatalogApi#triggerRecommendedEntities");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/software-catalog/UpsertIDPConfigValue.java

@@ -0,0 +1,42 @@
+// Create or update IDP configuration returns "No Content" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.SoftwareCatalogApi;
+import com.datadog.api.client.v2.model.IDPConfigRequest;
+import com.datadog.api.client.v2.model.IDPConfigRequestAttributes;
+import com.datadog.api.client.v2.model.IDPConfigRequestData;
+import com.datadog.api.client.v2.model.IDPConfigType;
+import java.util.Collections;
+import java.util.Map;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setUnstableOperationEnabled("v2.upsertIDPConfigValue", true);
+    SoftwareCatalogApi apiInstance = new SoftwareCatalogApi(defaultClient);
+
+    IDPConfigRequest body =
+        new IDPConfigRequest()
+            .data(
+                new IDPConfigRequestData()
+                    .attributes(
+                        new IDPConfigRequestAttributes()
+                            .value(
+                                Collections.singletonList(
+                                    Map.ofEntries(
+                                        Map.entry("displayName", "My Dashboard"),
+                                        Map.entry("id", "dashboard-1")))))
+                    .type(IDPConfigType.IDP_CONFIG));
+
+    try {
+      apiInstance.upsertIDPConfigValue("idp_pinned_dashboards", body);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling SoftwareCatalogApi#upsertIDPConfigValue");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

src/main/java/com/datadog/api/client/ApiClient.java

@@ -775,6 +775,12 @@ public class ApiClient {
           put("v2.getOpenAPI", false);
           put("v2.listAPIs", false);
           put("v2.updateOpenAPI", false);
+          put("v2.acceptRecommendedEntities", false);
+          put("v2.convertCatalogEntities", false);
+          put("v2.declineRecommendedEntities", false);
+          put("v2.getIDPConfigValue", false);
+          put("v2.triggerRecommendedEntities", false);
+          put("v2.upsertIDPConfigValue", false);
           put("v2.cancelThreatHuntingJob", false);
           put("v2.convertJobResultToSignal", false);
           put("v2.deleteThreatHuntingJob", false);