Add OpenAPI documentation for scorecards endpoints

examples/v2/service-scorecards/CreateScorecardCampaign.java

@@ -0,0 +1,50 @@
+// Create a new campaign returns "Created" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.ServiceScorecardsApi;
+import com.datadog.api.client.v2.model.CampaignResponse;
+import com.datadog.api.client.v2.model.CampaignStatus;
+import com.datadog.api.client.v2.model.CampaignType;
+import com.datadog.api.client.v2.model.CreateCampaignRequest;
+import com.datadog.api.client.v2.model.CreateCampaignRequestAttributes;
+import com.datadog.api.client.v2.model.CreateCampaignRequestData;
+import java.time.OffsetDateTime;
+import java.util.Arrays;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setUnstableOperationEnabled("v2.createScorecardCampaign", true);
+    ServiceScorecardsApi apiInstance = new ServiceScorecardsApi(defaultClient);
+
+    CreateCampaignRequest body =
+        new CreateCampaignRequest()
+            .data(
+                new CreateCampaignRequestData()
+                    .attributes(
+                        new CreateCampaignRequestAttributes()
+                            .description("Campaign to improve security posture for Q1 2024.")
+                            .dueDate(OffsetDateTime.parse("2024-03-31T23:59:59Z"))
+                            .entityScope("kind:service AND team:platform")
+                            .guidance("Please ensure all services pass the security requirements.")
+                            .key("q1-security-2024")
+                            .name("Q1 Security Campaign")
+                            .ownerId("550e8400-e29b-41d4-a716-446655440000")
+                            .ruleIds(Arrays.asList("q8MQxk8TCqrHnWkx", "r9NRyl9UDrsIoXly"))
+                            .startDate(OffsetDateTime.parse("2024-01-01T00:00:00Z"))
+                            .status(CampaignStatus.IN_PROGRESS))
+                    .type(CampaignType.CAMPAIGN));
+
+    try {
+      CampaignResponse result = apiInstance.createScorecardCampaign(body);
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling ServiceScorecardsApi#createScorecardCampaign");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/service-scorecards/DeleteScorecardCampaign.java

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

examples/v2/service-scorecards/DeleteScorecardRuleWorkflow.java

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

examples/v2/service-scorecards/GenerateScorecardCampaignReport.java

@@ -0,0 +1,43 @@
+// Generate campaign report returns "Accepted" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.ServiceScorecardsApi;
+import com.datadog.api.client.v2.model.GenerateCampaignReportRequest;
+import com.datadog.api.client.v2.model.GenerateCampaignReportRequestAttributes;
+import com.datadog.api.client.v2.model.GenerateCampaignReportRequestData;
+import com.datadog.api.client.v2.model.GenerateCampaignReportRequestDataType;
+import com.datadog.api.client.v2.model.SlackRoutingOptions;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setUnstableOperationEnabled("v2.generateScorecardCampaignReport", true);
+    ServiceScorecardsApi apiInstance = new ServiceScorecardsApi(defaultClient);
+
+    GenerateCampaignReportRequest body =
+        new GenerateCampaignReportRequest()
+            .data(
+                new GenerateCampaignReportRequestData()
+                    .attributes(
+                        new GenerateCampaignReportRequestAttributes()
+                            .slack(
+                                new SlackRoutingOptions()
+                                    .channelId("C024BDQ4N")
+                                    .channelName("service-scorecards")
+                                    .workspaceId("T024BDQ4N")
+                                    .workspaceName("datadog-workspace")))
+                    .type(GenerateCampaignReportRequestDataType.CAMPAIGN_REPORT));
+
+    try {
+      apiInstance.generateScorecardCampaignReport("c10ODp0VCrrIpXmz", body);
+    } catch (ApiException e) {
+      System.err.println(
+          "Exception when calling ServiceScorecardsApi#generateScorecardCampaignReport");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/service-scorecards/GenerateScorecardCampaignTeamReports.java

@@ -0,0 +1,47 @@
+// Generate team-specific campaign reports returns "Accepted" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.ServiceScorecardsApi;
+import com.datadog.api.client.v2.model.EntityOwnerDestination;
+import com.datadog.api.client.v2.model.GenerateCampaignTeamReportsRequest;
+import com.datadog.api.client.v2.model.GenerateCampaignTeamReportsRequestAttributes;
+import com.datadog.api.client.v2.model.GenerateCampaignTeamReportsRequestData;
+import com.datadog.api.client.v2.model.GenerateCampaignTeamReportsRequestDataType;
+import com.datadog.api.client.v2.model.SlackRoutingOptions;
+import java.util.Collections;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setUnstableOperationEnabled("v2.generateScorecardCampaignTeamReports", true);
+    ServiceScorecardsApi apiInstance = new ServiceScorecardsApi(defaultClient);
+
+    GenerateCampaignTeamReportsRequest body =
+        new GenerateCampaignTeamReportsRequest()
+            .data(
+                new GenerateCampaignTeamReportsRequestData()
+                    .attributes(
+                        new GenerateCampaignTeamReportsRequestAttributes()
+                            .entityOwners(
+                                Collections.singletonList(
+                                    new EntityOwnerDestination()
+                                        .slack(
+                                            new SlackRoutingOptions()
+                                                .channelId("C024BDQ4N")
+                                                .workspaceId("T024BDQ4N"))
+                                        .teamId("550e8400-e29b-41d4-a716-446655440000"))))
+                    .type(GenerateCampaignTeamReportsRequestDataType.CAMPAIGN_TEAM_REPORT));
+
+    try {
+      apiInstance.generateScorecardCampaignTeamReports("c10ODp0VCrrIpXmz", body);
+    } catch (ApiException e) {
+      System.err.println(
+          "Exception when calling ServiceScorecardsApi#generateScorecardCampaignTeamReports");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/service-scorecards/GetScorecardCampaign.java

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

examples/v2/service-scorecards/ListScorecardCampaigns.java

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

examples/v2/service-scorecards/ListScorecardDefaultRules.java

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

examples/v2/service-scorecards/ListScorecardFacets.java

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

examples/v2/service-scorecards/ListScorecardScores.java

@@ -0,0 +1,25 @@
+// List scores by aggregation returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.ServiceScorecardsApi;
+import com.datadog.api.client.v2.model.ListScoresResponse;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setUnstableOperationEnabled("v2.listScorecardScores", true);
+    ServiceScorecardsApi apiInstance = new ServiceScorecardsApi(defaultClient);
+
+    try {
+      ListScoresResponse result = apiInstance.listScorecardScores("by-entity");
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling ServiceScorecardsApi#listScorecardScores");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/service-scorecards/ListScorecards.java

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

examples/v2/service-scorecards/SetupScorecardRules.java

@@ -0,0 +1,38 @@
+// Setup rules for organization returns "No Content" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.ServiceScorecardsApi;
+import com.datadog.api.client.v2.model.SetupRulesRequest;
+import com.datadog.api.client.v2.model.SetupRulesRequestAttributes;
+import com.datadog.api.client.v2.model.SetupRulesRequestData;
+import com.datadog.api.client.v2.model.SetupRulesRequestDataType;
+import java.util.Arrays;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setUnstableOperationEnabled("v2.setupScorecardRules", true);
+    ServiceScorecardsApi apiInstance = new ServiceScorecardsApi(defaultClient);
+
+    SetupRulesRequest body =
+        new SetupRulesRequest()
+            .data(
+                new SetupRulesRequestData()
+                    .attributes(
+                        new SetupRulesRequestAttributes()
+                            .disabledDefaultRules(
+                                Arrays.asList("q8MQxk8TCqrHnWkx", "r9NRyl9UDrsIoXly")))
+                    .type(SetupRulesRequestDataType.SETUP));
+
+    try {
+      apiInstance.setupScorecardRules(body);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling ServiceScorecardsApi#setupScorecardRules");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}