Add OpenAPI documentation for scorecards endpoints

examples/v2/scorecards/CreateScorecardCampaign.java

@@ -0,0 +1,49 @@
+// 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.ScorecardsApi;
+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();
+    ScorecardsApi apiInstance = new ScorecardsApi(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 ScorecardsApi#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/CreateScorecardOutcomesBatch.java → examples/v2/scorecards/CreateScorecardOutcomesBatch.java

@@ -2,7 +2,7 @@
 
 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.api.ScorecardsApi;
 import com.datadog.api.client.v2.model.OutcomesBatchAttributes;
 import com.datadog.api.client.v2.model.OutcomesBatchRequest;
 import com.datadog.api.client.v2.model.OutcomesBatchRequestData;
@@ -16,10 +16,7 @@ public class Example {
   public static void main(String[] args) {
     ApiClient defaultClient = ApiClient.getDefaultApiClient();
     defaultClient.setUnstableOperationEnabled("v2.createScorecardOutcomesBatch", true);
-    ServiceScorecardsApi apiInstance = new ServiceScorecardsApi(defaultClient);
-
-    // there is a valid "create_scorecard_rule" in the system
-    String CREATE_SCORECARD_RULE_DATA_ID = System.getenv("CREATE_SCORECARD_RULE_DATA_ID");
+    ScorecardsApi apiInstance = new ScorecardsApi(defaultClient);
 
     OutcomesBatchRequest body =
         new OutcomesBatchRequest()
@@ -34,7 +31,7 @@ public static void main(String[] args) {
                                             """
 See: <a href="https://app.datadoghq.com/services">Services</a>
 """)
-                                        .ruleId(CREATE_SCORECARD_RULE_DATA_ID)
+                                        .ruleId("q8MQxk8TCqrHnWkx")
                                         .serviceName("my-service")
                                         .state(State.PASS))))
                     .type(OutcomesBatchType.BATCHED_OUTCOME));
@@ -43,8 +40,7 @@ public static void main(String[] args) {
       OutcomesBatchResponse result = apiInstance.createScorecardOutcomesBatch(body);
       System.out.println(result);
     } catch (ApiException e) {
-      System.err.println(
-          "Exception when calling ServiceScorecardsApi#createScorecardOutcomesBatch");
+      System.err.println("Exception when calling ScorecardsApi#createScorecardOutcomesBatch");
       System.err.println("Status code: " + e.getCode());
       System.err.println("Reason: " + e.getResponseBody());
       System.err.println("Response headers: " + e.getResponseHeaders());

examples/v2/service-scorecards/CreateScorecardRule.java → examples/v2/scorecards/CreateScorecardRule.java

@@ -2,35 +2,36 @@
 
 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.api.ScorecardsApi;
 import com.datadog.api.client.v2.model.CreateRuleRequest;
 import com.datadog.api.client.v2.model.CreateRuleRequestData;
 import com.datadog.api.client.v2.model.CreateRuleResponse;
-import com.datadog.api.client.v2.model.RuleAttributes;
+import com.datadog.api.client.v2.model.RuleAttributesRequest;
 import com.datadog.api.client.v2.model.RuleType;
 
 public class Example {
   public static void main(String[] args) {
     ApiClient defaultClient = ApiClient.getDefaultApiClient();
-    defaultClient.setUnstableOperationEnabled("v2.createScorecardRule", true);
-    ServiceScorecardsApi apiInstance = new ServiceScorecardsApi(defaultClient);
+    ScorecardsApi apiInstance = new ScorecardsApi(defaultClient);
 
     CreateRuleRequest body =
         new CreateRuleRequest()
             .data(
                 new CreateRuleRequestData()
                     .attributes(
-                        new RuleAttributes()
+                        new RuleAttributesRequest()
                             .enabled(true)
-                            .name("Example-Service-Scorecard")
-                            .scorecardName("Observability Best Practices"))
+                            .level(2)
+                            .name("Team Defined")
+                            .scopeQuery("kind:service")
+                            .scorecardName("Deployments automated via Deployment Trains"))
                     .type(RuleType.RULE));
 
     try {
       CreateRuleResponse result = apiInstance.createScorecardRule(body);
       System.out.println(result);
     } catch (ApiException e) {
-      System.err.println("Exception when calling ServiceScorecardsApi#createScorecardRule");
+      System.err.println("Exception when calling ScorecardsApi#createScorecardRule");
       System.err.println("Status code: " + e.getCode());
       System.err.println("Reason: " + e.getResponseBody());
       System.err.println("Response headers: " + e.getResponseHeaders());

examples/v2/scorecards/DeleteScorecardCampaign.java

@@ -0,0 +1,22 @@
+// 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.ScorecardsApi;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    ScorecardsApi apiInstance = new ScorecardsApi(defaultClient);
+
+    try {
+      apiInstance.deleteScorecardCampaign("c10ODp0VCrrIpXmz");
+    } catch (ApiException e) {
+      System.err.println("Exception when calling ScorecardsApi#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/scorecards/DeleteScorecardRule.java

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

examples/v2/scorecards/GetScorecardCampaign.java

@@ -0,0 +1,24 @@
+// 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.ScorecardsApi;
+import com.datadog.api.client.v2.model.CampaignResponse;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    ScorecardsApi apiInstance = new ScorecardsApi(defaultClient);
+
+    try {
+      CampaignResponse result = apiInstance.getScorecardCampaign("c10ODp0VCrrIpXmz");
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling ScorecardsApi#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/scorecards/ListScorecardCampaigns.java

@@ -0,0 +1,24 @@
+// 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.ScorecardsApi;
+import com.datadog.api.client.v2.model.ListCampaignsResponse;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    ScorecardsApi apiInstance = new ScorecardsApi(defaultClient);
+
+    try {
+      ListCampaignsResponse result = apiInstance.listScorecardCampaigns();
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling ScorecardsApi#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/ListScorecardOutcomes.java → examples/v2/scorecards/ListScorecardOutcomes.java

@@ -2,20 +2,19 @@
 
 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.api.ScorecardsApi;
 import com.datadog.api.client.v2.model.OutcomesResponse;
 
 public class Example {
   public static void main(String[] args) {
     ApiClient defaultClient = ApiClient.getDefaultApiClient();
-    defaultClient.setUnstableOperationEnabled("v2.listScorecardOutcomes", true);
-    ServiceScorecardsApi apiInstance = new ServiceScorecardsApi(defaultClient);
+    ScorecardsApi apiInstance = new ScorecardsApi(defaultClient);
 
     try {
       OutcomesResponse result = apiInstance.listScorecardOutcomes();
       System.out.println(result);
     } catch (ApiException e) {
-      System.err.println("Exception when calling ServiceScorecardsApi#listScorecardOutcomes");
+      System.err.println("Exception when calling ScorecardsApi#listScorecardOutcomes");
       System.err.println("Status code: " + e.getCode());
       System.err.println("Reason: " + e.getResponseBody());
       System.err.println("Response headers: " + e.getResponseHeaders());

examples/v2/service-scorecards/ListScorecardOutcomes_2663454275.java → examples/v2/scorecards/ListScorecardOutcomes_2663454275.java

@@ -2,30 +2,24 @@
 
 import com.datadog.api.client.ApiClient;
 import com.datadog.api.client.PaginationIterable;
-import com.datadog.api.client.v2.api.ServiceScorecardsApi;
-import com.datadog.api.client.v2.api.ServiceScorecardsApi.ListScorecardOutcomesOptionalParameters;
+import com.datadog.api.client.v2.api.ScorecardsApi;
 import com.datadog.api.client.v2.model.OutcomesResponseDataItem;
 
 public class Example {
   public static void main(String[] args) {
     ApiClient defaultClient = ApiClient.getDefaultApiClient();
-    defaultClient.setUnstableOperationEnabled("v2.listScorecardOutcomes", true);
-    ServiceScorecardsApi apiInstance = new ServiceScorecardsApi(defaultClient);
+    ScorecardsApi apiInstance = new ScorecardsApi(defaultClient);
 
     try {
       PaginationIterable<OutcomesResponseDataItem> iterable =
-          apiInstance.listScorecardOutcomesWithPagination(
-              new ListScorecardOutcomesOptionalParameters()
-                  .pageSize(2L)
-                  .fieldsOutcome("state")
-                  .filterOutcomeServiceName("my-service"));
+          apiInstance.listScorecardOutcomesWithPagination();
 
       for (OutcomesResponseDataItem item : iterable) {
         System.out.println(item);
       }
     } catch (RuntimeException e) {
       System.err.println(
-          "Exception when calling ServiceScorecardsApi#listScorecardOutcomesWithPagination");
+          "Exception when calling ScorecardsApi#listScorecardOutcomesWithPagination");
       System.err.println("Reason: " + e.getMessage());
       e.printStackTrace();
     }

examples/v2/service-scorecards/ListScorecardRules.java → examples/v2/scorecards/ListScorecardRules.java

@@ -2,20 +2,19 @@
 
 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.api.ScorecardsApi;
 import com.datadog.api.client.v2.model.ListRulesResponse;
 
 public class Example {
   public static void main(String[] args) {
     ApiClient defaultClient = ApiClient.getDefaultApiClient();
-    defaultClient.setUnstableOperationEnabled("v2.listScorecardRules", true);
-    ServiceScorecardsApi apiInstance = new ServiceScorecardsApi(defaultClient);
+    ScorecardsApi apiInstance = new ScorecardsApi(defaultClient);
 
     try {
       ListRulesResponse result = apiInstance.listScorecardRules();
       System.out.println(result);
     } catch (ApiException e) {
-      System.err.println("Exception when calling ServiceScorecardsApi#listScorecardRules");
+      System.err.println("Exception when calling ScorecardsApi#listScorecardRules");
       System.err.println("Status code: " + e.getCode());
       System.err.println("Reason: " + e.getResponseBody());
       System.err.println("Response headers: " + e.getResponseHeaders());

examples/v2/scorecards/ListScorecardRules_4057666343.java

@@ -0,0 +1,26 @@
+// List all rules returns "OK" response with pagination
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.PaginationIterable;
+import com.datadog.api.client.v2.api.ScorecardsApi;
+import com.datadog.api.client.v2.model.ListRulesResponseDataItem;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    ScorecardsApi apiInstance = new ScorecardsApi(defaultClient);
+
+    try {
+      PaginationIterable<ListRulesResponseDataItem> iterable =
+          apiInstance.listScorecardRulesWithPagination();
+
+      for (ListRulesResponseDataItem item : iterable) {
+        System.out.println(item);
+      }
+    } catch (RuntimeException e) {
+      System.err.println("Exception when calling ScorecardsApi#listScorecardRulesWithPagination");
+      System.err.println("Reason: " + e.getMessage());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/scorecards/ListScorecards.java

@@ -0,0 +1,24 @@
+// 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.ScorecardsApi;
+import com.datadog.api.client.v2.model.ListScorecardsResponse;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    ScorecardsApi apiInstance = new ScorecardsApi(defaultClient);
+
+    try {
+      ListScorecardsResponse result = apiInstance.listScorecards();
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling ScorecardsApi#listScorecards");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}