Add OpenAPI documentation for scorecards endpoints

cassettes/v2/Service-Scorecards_320411317/Create-a-new-rule-returns-Bad-Request-response_4112202994/recording.har → cassettes/v2/Scorecards_1099427156/Create-a-new-rule-returns-Bad-Request-response_4112202994/recording.har

@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Service Scorecards/Create a new rule returns \"Bad Request\" response",
+    "_recordingName": "Scorecards/Create a new rule returns \"Bad Request\" response",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",

cassettes/v2/Service-Scorecards_320411317/Create-a-new-rule-returns-Created-response_522570232/recording.har → cassettes/v2/Scorecards_1099427156/Create-a-new-rule-returns-Created-response_522570232/recording.har

@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Service Scorecards/Create a new rule returns \"Created\" response",
+    "_recordingName": "Scorecards/Create a new rule returns \"Created\" response",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",

cassettes/v2/Service-Scorecards_320411317/Create-outcomes-batch-returns-Bad-Request-response_4200540942/recording.har → cassettes/v2/Scorecards_1099427156/Create-outcomes-batch-returns-Bad-Request-response_4200540942/recording.har

@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Service Scorecards/Create outcomes batch returns \"Bad Request\" response",
+    "_recordingName": "Scorecards/Create outcomes batch returns \"Bad Request\" response",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",

cassettes/v2/Service-Scorecards_320411317/Create-outcomes-batch-returns-OK-response_3991487588/recording.har → cassettes/v2/Scorecards_1099427156/Create-outcomes-batch-returns-OK-response_3991487588/recording.har

@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Service Scorecards/Create outcomes batch returns \"OK\" response",
+    "_recordingName": "Scorecards/Create outcomes batch returns \"OK\" response",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",

cassettes/v2/Service-Scorecards_320411317/Delete-a-rule-returns-Not-Found-response_164235844/recording.har → cassettes/v2/Scorecards_1099427156/Delete-a-rule-returns-Not-Found-response_164235844/recording.har

@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Service Scorecards/Delete a rule returns \"Not Found\" response",
+    "_recordingName": "Scorecards/Delete a rule returns \"Not Found\" response",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",

cassettes/v2/Service-Scorecards_320411317/Delete-a-rule-returns-OK-response_1881171271/recording.har → cassettes/v2/Scorecards_1099427156/Delete-a-rule-returns-OK-response_1881171271/recording.har

@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Service Scorecards/Delete a rule returns \"OK\" response",
+    "_recordingName": "Scorecards/Delete a rule returns \"OK\" response",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",

cassettes/v2/Service-Scorecards_320411317/Get-all-rules-returns-OK-response_1077715861/recording.har → cassettes/v2/Scorecards_1099427156/Get-all-rules-returns-OK-response_1077715861/recording.har

@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Service Scorecards/Get all rules returns \"OK\" response",
+    "_recordingName": "Scorecards/Get all rules returns \"OK\" response",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",

cassettes/v2/Service-Scorecards_320411317/List-all-rule-outcomes-returns-OK-response-with-pagination_1119793127/recording.har → cassettes/v2/Scorecards_1099427156/List-all-rule-outcomes-returns-OK-response-with-pagination_1119793127/recording.har

@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Service Scorecards/List all rule outcomes returns \"OK\" response with pagination",
+    "_recordingName": "Scorecards/List all rule outcomes returns \"OK\" response with pagination",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",

cassettes/v2/Service-Scorecards_320411317/List-all-rule-outcomes-returns-OK-response_427126415/recording.har → cassettes/v2/Scorecards_1099427156/List-all-rule-outcomes-returns-OK-response_427126415/recording.har

@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Service Scorecards/List all rule outcomes returns \"OK\" response",
+    "_recordingName": "Scorecards/List all rule outcomes returns \"OK\" response",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",

cassettes/v2/Service-Scorecards_320411317/List-all-rules-returns-OK-response-with-pagination_1123075563/recording.har → cassettes/v2/Scorecards_1099427156/List-all-rules-returns-OK-response-with-pagination_1123075563/recording.har

@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Service Scorecards/List all rules returns \"OK\" response with pagination",
+    "_recordingName": "Scorecards/List all rules returns \"OK\" response with pagination",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",

cassettes/v2/Service-Scorecards_320411317/List-all-rules-returns-OK-response_4242635547/recording.har → cassettes/v2/Scorecards_1099427156/List-all-rules-returns-OK-response_4242635547/recording.har

@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Service Scorecards/List all rules returns \"OK\" response",
+    "_recordingName": "Scorecards/List all rules returns \"OK\" response",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",

cassettes/v2/Service-Scorecards_320411317/Update-Scorecard-outcomes-asynchronously-returns-Accepted-response_3550004421/recording.har → cassettes/v2/Scorecards_1099427156/Update-Scorecard-outcomes-asynchronously-returns-Accepted-response_3550004421/recording.har

@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Service Scorecards/Update Scorecard outcomes asynchronously returns \"Accepted\" response",
+    "_recordingName": "Scorecards/Update Scorecard outcomes asynchronously returns \"Accepted\" response",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",

cassettes/v2/Service-Scorecards_320411317/Update-Scorecard-outcomes-asynchronously-returns-Bad-Request-response_3858316768/recording.har → cassettes/v2/Scorecards_1099427156/Update-Scorecard-outcomes-asynchronously-returns-Bad-Request-response_3858316768/recording.har

@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Service Scorecards/Update Scorecard outcomes asynchronously returns \"Bad Request\" response",
+    "_recordingName": "Scorecards/Update Scorecard outcomes asynchronously returns \"Bad Request\" response",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",

cassettes/v2/Service-Scorecards_320411317/Update-Scorecard-outcomes-asynchronously-returns-Conflict-response_2488160814/recording.har → cassettes/v2/Scorecards_1099427156/Update-Scorecard-outcomes-asynchronously-returns-Conflict-response_2488160814/recording.har

@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Service Scorecards/Update Scorecard outcomes asynchronously returns \"Conflict\" response",
+    "_recordingName": "Scorecards/Update Scorecard outcomes asynchronously returns \"Conflict\" response",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",

cassettes/v2/Service-Scorecards_320411317/Update-an-existing-rule-returns-Rule-updated-successfully-response_2113887026/recording.har → cassettes/v2/Scorecards_1099427156/Update-an-existing-rule-returns-Rule-updated-successfully-response_2113887026/recording.har

@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Service Scorecards/Update an existing rule returns \"Rule updated successfully\" response",
+    "_recordingName": "Scorecards/Update an existing rule returns \"Rule updated successfully\" response",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",
@@ -61,11 +61,11 @@
         "time": 118
       },
       {
-        "_id": "c173c2c3af4ee37c6f4319a3182dd04d",
+        "_id": "14405d8c52a73cea87ac1473d69830e0",
         "_order": 0,
         "cache": {},
         "request": {
-          "bodySize": 229,
+          "bodySize": 243,
           "cookies": [],
           "headers": [
             {
@@ -85,7 +85,7 @@
           "postData": {
             "mimeType": "application/json",
             "params": [],
-            "text": "{\"data\":{\"attributes\":{\"description\":\"Updated description via test\",\"enabled\":true,\"name\":\"Test-Update_an_existing_rule_returns_Rule_updated_successfully_response-1722307632\",\"scorecard_name\":\"OpenAPI Spec Test Best Practices\"}}}"
+            "text": "{\"data\":{\"attributes\":{\"description\":\"Updated description via test\",\"enabled\":true,\"name\":\"Test-Update_an_existing_rule_returns_Rule_updated_successfully_response-1722307632\",\"scorecard_name\":\"OpenAPI Spec Test Best Practices\"},\"type\":\"rule\"}}"
           },
           "queryString": [],
           "url": "https://api.datadoghq.com/api/v2/scorecard/rules/L2uJseIxQCRLg_2z"

cassettes/v2/Service-Scorecards_320411317/Update-an-existing-scorecard-rule-returns-Bad-Request-response_3943964706/recording.har → cassettes/v2/Scorecards_1099427156/Update-an-existing-scorecard-rule-returns-Bad-Request-response_3943964706/recording.har

@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Service Scorecards/Update an existing scorecard rule returns \"Bad Request\" response",
+    "_recordingName": "Scorecards/Update an existing scorecard rule returns \"Bad Request\" response",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",

cassettes/v2/Service-Scorecards_320411317/Update-an-existing-scorecard-rule-returns-Not-Found-response_955343473/recording.har → cassettes/v2/Scorecards_1099427156/Update-an-existing-scorecard-rule-returns-Not-Found-response_955343473/recording.har

@@ -1,6 +1,6 @@
 {
   "log": {
-    "_recordingName": "Service Scorecards/Update an existing scorecard rule returns \"Not Found\" response",
+    "_recordingName": "Scorecards/Update an existing scorecard rule returns \"Not Found\" response",
     "creator": {
       "comment": "persister:fs",
       "name": "Polly.JS",

examples/v2/scorecards/CreateScorecardCampaign.ts

@@ -0,0 +1,37 @@
+/**
+ * Create a new campaign returns "Created" response
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.ScorecardsApi(configuration);
+
+const params: v2.ScorecardsApiCreateScorecardCampaignRequest = {
+  body: {
+    data: {
+      attributes: {
+        description: "Campaign to improve security posture for Q1 2024.",
+        dueDate: new Date(2024, 3, 31, 23, 59, 59, 0),
+        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: ["q8MQxk8TCqrHnWkx", "r9NRyl9UDrsIoXly"],
+        startDate: new Date(2024, 1, 1, 0, 0, 0, 0),
+        status: "in_progress",
+      },
+      type: "campaign",
+    },
+  },
+};
+
+apiInstance
+  .createScorecardCampaign(params)
+  .then((data: v2.CampaignResponse) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

examples/v2/service-scorecards/CreateScorecardOutcomesBatch.ts → examples/v2/scorecards/CreateScorecardOutcomesBatch.ts

@@ -6,13 +6,13 @@ import { client, v2 } from "@datadog/datadog-api-client";
 
 const configuration = client.createConfiguration();
 configuration.unstableOperations["v2.createScorecardOutcomesBatch"] = true;
-const apiInstance = new v2.ServiceScorecardsApi(configuration);
+const apiInstance = new v2.ScorecardsApi(configuration);
 
 // there is a valid "create_scorecard_rule" in the system
 const CREATE_SCORECARD_RULE_DATA_ID = process.env
   .CREATE_SCORECARD_RULE_DATA_ID as string;
 
-const params: v2.ServiceScorecardsApiCreateScorecardOutcomesBatchRequest = {
+const params: v2.ScorecardsApiCreateScorecardOutcomesBatchRequest = {
   body: {
     data: {
       attributes: {

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

@@ -5,15 +5,14 @@
 import { client, v2 } from "@datadog/datadog-api-client";
 
 const configuration = client.createConfiguration();
-configuration.unstableOperations["v2.createScorecardRule"] = true;
-const apiInstance = new v2.ServiceScorecardsApi(configuration);
+const apiInstance = new v2.ScorecardsApi(configuration);
 
-const params: v2.ServiceScorecardsApiCreateScorecardRuleRequest = {
+const params: v2.ScorecardsApiCreateScorecardRuleRequest = {
   body: {
     data: {
       attributes: {
         enabled: true,
-        name: "Example-Service-Scorecard",
+        name: "Example-Scorecard",
         scorecardName: "Observability Best Practices",
       },
       type: "rule",

examples/v2/scorecards/DeleteScorecardCampaign.ts

@@ -0,0 +1,21 @@
+/**
+ * Delete a campaign returns "No Content" response
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.ScorecardsApi(configuration);
+
+const params: v2.ScorecardsApiDeleteScorecardCampaignRequest = {
+  campaignId: "c10ODp0VCrrIpXmz",
+};
+
+apiInstance
+  .deleteScorecardCampaign(params)
+  .then((data: any) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

examples/v2/service-scorecards/DeleteScorecardRule.ts → examples/v2/scorecards/DeleteScorecardRule.ts

@@ -5,14 +5,13 @@
 import { client, v2 } from "@datadog/datadog-api-client";
 
 const configuration = client.createConfiguration();
-configuration.unstableOperations["v2.deleteScorecardRule"] = true;
-const apiInstance = new v2.ServiceScorecardsApi(configuration);
+const apiInstance = new v2.ScorecardsApi(configuration);
 
 // there is a valid "create_scorecard_rule" in the system
 const CREATE_SCORECARD_RULE_DATA_ID = process.env
   .CREATE_SCORECARD_RULE_DATA_ID as string;
 
-const params: v2.ServiceScorecardsApiDeleteScorecardRuleRequest = {
+const params: v2.ScorecardsApiDeleteScorecardRuleRequest = {
   ruleId: CREATE_SCORECARD_RULE_DATA_ID,
 };
 

examples/v2/scorecards/GetScorecardCampaign.ts

@@ -0,0 +1,21 @@
+/**
+ * Get a campaign returns "OK" response
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.ScorecardsApi(configuration);
+
+const params: v2.ScorecardsApiGetScorecardCampaignRequest = {
+  campaignId: "c10ODp0VCrrIpXmz",
+};
+
+apiInstance
+  .getScorecardCampaign(params)
+  .then((data: v2.CampaignResponse) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

examples/v2/scorecards/ListScorecardCampaigns.ts

@@ -0,0 +1,17 @@
+/**
+ * List all campaigns returns "OK" response
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.ScorecardsApi(configuration);
+
+apiInstance
+  .listScorecardCampaigns()
+  .then((data: v2.ListCampaignsResponse) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

examples/v2/service-scorecards/ListScorecardOutcomes.ts → examples/v2/scorecards/ListScorecardOutcomes.ts

@@ -5,8 +5,7 @@
 import { client, v2 } from "@datadog/datadog-api-client";
 
 const configuration = client.createConfiguration();
-configuration.unstableOperations["v2.listScorecardOutcomes"] = true;
-const apiInstance = new v2.ServiceScorecardsApi(configuration);
+const apiInstance = new v2.ScorecardsApi(configuration);
 
 apiInstance
   .listScorecardOutcomes()

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

@@ -5,10 +5,9 @@
 import { client, v2 } from "@datadog/datadog-api-client";
 
 const configuration = client.createConfiguration();
-configuration.unstableOperations["v2.listScorecardOutcomes"] = true;
-const apiInstance = new v2.ServiceScorecardsApi(configuration);
+const apiInstance = new v2.ScorecardsApi(configuration);
 
-const params: v2.ServiceScorecardsApiListScorecardOutcomesRequest = {
+const params: v2.ScorecardsApiListScorecardOutcomesRequest = {
   pageSize: 2,
   fieldsOutcome: "state",
   filterOutcomeServiceName: "my-service",

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

@@ -5,8 +5,7 @@
 import { client, v2 } from "@datadog/datadog-api-client";
 
 const configuration = client.createConfiguration();
-configuration.unstableOperations["v2.listScorecardRules"] = true;
-const apiInstance = new v2.ServiceScorecardsApi(configuration);
+const apiInstance = new v2.ScorecardsApi(configuration);
 
 apiInstance
   .listScorecardRules()

examples/v2/service-scorecards/ListScorecardRules_4057666343.ts → examples/v2/scorecards/ListScorecardRules_4057666343.ts

@@ -5,10 +5,9 @@
 import { client, v2 } from "@datadog/datadog-api-client";
 
 const configuration = client.createConfiguration();
-configuration.unstableOperations["v2.listScorecardRules"] = true;
-const apiInstance = new v2.ServiceScorecardsApi(configuration);
+const apiInstance = new v2.ScorecardsApi(configuration);
 
-const params: v2.ServiceScorecardsApiListScorecardRulesRequest = {
+const params: v2.ScorecardsApiListScorecardRulesRequest = {
   pageSize: 2,
   filterRuleCustom: true,
   fieldsRule: "name",

examples/v2/scorecards/ListScorecards.ts

@@ -0,0 +1,17 @@
+/**
+ * List all scorecards returns "OK" response
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.ScorecardsApi(configuration);
+
+apiInstance
+  .listScorecards()
+  .then((data: v2.ListScorecardsResponse) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));