Add OpenAPI documentation for scorecards endpoints

examples/v2/scorecards/CreateScorecardCampaign.rb

@@ -0,0 +1,26 @@
+# Create a new campaign returns "Created" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::ScorecardsAPI.new
+
+body = DatadogAPIClient::V2::CreateCampaignRequest.new({
+  data: DatadogAPIClient::V2::CreateCampaignRequestData.new({
+    attributes: DatadogAPIClient::V2::CreateCampaignRequestAttributes.new({
+      description: "Campaign to improve security posture for Q1 2024.",
+      due_date: "2024-03-31T23:59:59Z",
+      entity_scope: "kind:service AND team:platform",
+      guidance: "Please ensure all services pass the security requirements.",
+      key: "q1-security-2024",
+      name: "Q1 Security Campaign",
+      owner_id: "550e8400-e29b-41d4-a716-446655440000",
+      rule_ids: [
+        "q8MQxk8TCqrHnWkx",
+        "r9NRyl9UDrsIoXly",
+      ],
+      start_date: "2024-01-01T00:00:00Z",
+      status: DatadogAPIClient::V2::CampaignStatus::IN_PROGRESS,
+    }),
+    type: DatadogAPIClient::V2::CampaignType::CAMPAIGN,
+  }),
+})
+p api_instance.create_scorecard_campaign(body)

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

@@ -4,7 +4,7 @@
 DatadogAPIClient.configure do |config|
   config.unstable_operations["v2.create_scorecard_outcomes_batch".to_sym] = true
 end
-api_instance = DatadogAPIClient::V2::ServiceScorecardsAPI.new
+api_instance = DatadogAPIClient::V2::ScorecardsAPI.new
 
 # there is a valid "create_scorecard_rule" in the system
 CREATE_SCORECARD_RULE_DATA_ID = ENV["CREATE_SCORECARD_RULE_DATA_ID"]

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

@@ -1,16 +1,13 @@
 # Create a new rule returns "Created" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.create_scorecard_rule".to_sym] = true
-end
-api_instance = DatadogAPIClient::V2::ServiceScorecardsAPI.new
+api_instance = DatadogAPIClient::V2::ScorecardsAPI.new
 
 body = DatadogAPIClient::V2::CreateRuleRequest.new({
   data: DatadogAPIClient::V2::CreateRuleRequestData.new({
-    attributes: DatadogAPIClient::V2::RuleAttributes.new({
+    attributes: DatadogAPIClient::V2::RuleAttributesRequest.new({
       enabled: true,
-      name: "Example-Service-Scorecard",
+      name: "Example-Scorecard",
       scorecard_name: "Observability Best Practices",
     }),
     type: DatadogAPIClient::V2::RuleType::RULE,

examples/v2/scorecards/DeleteScorecardCampaign.rb

@@ -0,0 +1,5 @@
+# Delete a campaign returns "No Content" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::ScorecardsAPI.new
+api_instance.delete_scorecard_campaign("c10ODp0VCrrIpXmz")

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

@@ -1,10 +1,7 @@
 # Delete a rule returns "OK" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.delete_scorecard_rule".to_sym] = true
-end
-api_instance = DatadogAPIClient::V2::ServiceScorecardsAPI.new
+api_instance = DatadogAPIClient::V2::ScorecardsAPI.new
 
 # there is a valid "create_scorecard_rule" in the system
 CREATE_SCORECARD_RULE_DATA_ID = ENV["CREATE_SCORECARD_RULE_DATA_ID"]

examples/v2/scorecards/GetScorecardCampaign.rb

@@ -0,0 +1,5 @@
+# Get a campaign returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::ScorecardsAPI.new
+p api_instance.get_scorecard_campaign("c10ODp0VCrrIpXmz")

examples/v2/scorecards/ListScorecardCampaigns.rb

@@ -0,0 +1,5 @@
+# List all campaigns returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::ScorecardsAPI.new
+p api_instance.list_scorecard_campaigns()

examples/v2/scorecards/ListScorecardOutcomes.rb

@@ -0,0 +1,5 @@
+# List all rule outcomes returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::ScorecardsAPI.new
+p api_instance.list_scorecard_outcomes()

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

@@ -1,10 +1,7 @@
 # List all rule outcomes returns "OK" response with pagination
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.list_scorecard_outcomes".to_sym] = true
-end
-api_instance = DatadogAPIClient::V2::ServiceScorecardsAPI.new
+api_instance = DatadogAPIClient::V2::ScorecardsAPI.new
 opts = {
   page_size: 2,
   fields_outcome: "state",

examples/v2/scorecards/ListScorecardRules.rb

@@ -0,0 +1,5 @@
+# List all rules returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::ScorecardsAPI.new
+p api_instance.list_scorecard_rules()

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

@@ -1,10 +1,7 @@
 # List all rules returns "OK" response with pagination
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.list_scorecard_rules".to_sym] = true
-end
-api_instance = DatadogAPIClient::V2::ServiceScorecardsAPI.new
+api_instance = DatadogAPIClient::V2::ScorecardsAPI.new
 opts = {
   page_size: 2,
   fields_rule: "name",

examples/v2/scorecards/ListScorecards.rb

@@ -0,0 +1,5 @@
+# List all scorecards returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::ScorecardsAPI.new
+p api_instance.list_scorecards()

examples/v2/scorecards/UpdateScorecardCampaign.rb

@@ -0,0 +1,26 @@
+# Update a campaign returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::ScorecardsAPI.new
+
+body = DatadogAPIClient::V2::UpdateCampaignRequest.new({
+  data: DatadogAPIClient::V2::UpdateCampaignRequestData.new({
+    attributes: DatadogAPIClient::V2::UpdateCampaignRequestAttributes.new({
+      description: "Campaign to improve security posture for Q1 2024.",
+      due_date: "2024-03-31T23:59:59Z",
+      entity_scope: "kind:service AND team:platform",
+      guidance: "Please ensure all services pass the security requirements.",
+      key: "q1-security-2024",
+      name: "Q1 Security Campaign",
+      owner_id: "550e8400-e29b-41d4-a716-446655440000",
+      rule_ids: [
+        "q8MQxk8TCqrHnWkx",
+        "r9NRyl9UDrsIoXly",
+      ],
+      start_date: "2024-01-01T00:00:00Z",
+      status: "in_progress",
+    }),
+    type: DatadogAPIClient::V2::CampaignType::CAMPAIGN,
+  }),
+})
+p api_instance.update_scorecard_campaign("c10ODp0VCrrIpXmz", body)

examples/v2/scorecards/UpdateScorecardOutcomes.rb

@@ -0,0 +1,21 @@
+# Update Scorecard outcomes returns "Accepted" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::ScorecardsAPI.new
+
+body = DatadogAPIClient::V2::UpdateOutcomesAsyncRequest.new({
+  data: DatadogAPIClient::V2::UpdateOutcomesAsyncRequestData.new({
+    attributes: DatadogAPIClient::V2::UpdateOutcomesAsyncAttributes.new({
+      results: [
+        DatadogAPIClient::V2::UpdateOutcomesAsyncRequestItem.new({
+          entity_reference: "service:my-service",
+          remarks: 'See: <a href="https://app.datadoghq.com/services">Services</a>',
+          rule_id: "q8MQxk8TCqrHnWkx",
+          state: DatadogAPIClient::V2::State::PASS,
+        }),
+      ],
+    }),
+    type: DatadogAPIClient::V2::UpdateOutcomesAsyncType::BATCHED_OUTCOME,
+  }),
+})
+p api_instance.update_scorecard_outcomes(body)

examples/v2/service-scorecards/UpdateScorecardOutcomesAsync.rb → examples/v2/scorecards/UpdateScorecardOutcomes_2262047257.rb

@@ -1,10 +1,7 @@
 # Update Scorecard outcomes asynchronously returns "Accepted" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.update_scorecard_outcomes_async".to_sym] = true
-end
-api_instance = DatadogAPIClient::V2::ServiceScorecardsAPI.new
+api_instance = DatadogAPIClient::V2::ScorecardsAPI.new
 
 # there is a valid "create_scorecard_rule" in the system
 CREATE_SCORECARD_RULE_DATA_ID = ENV["CREATE_SCORECARD_RULE_DATA_ID"]
@@ -24,4 +21,4 @@
     type: DatadogAPIClient::V2::UpdateOutcomesAsyncType::BATCHED_OUTCOME,
   }),
 })
-p api_instance.update_scorecard_outcomes_async(body)
+p api_instance.update_scorecard_outcomes(body)

examples/v2/scorecards/UpdateScorecardRule.rb

@@ -0,0 +1,18 @@
+# Update an existing scorecard rule returns "Rule updated successfully" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::ScorecardsAPI.new
+
+body = DatadogAPIClient::V2::UpdateRuleRequest.new({
+  data: DatadogAPIClient::V2::UpdateRuleRequestData.new({
+    attributes: DatadogAPIClient::V2::RuleAttributesRequest.new({
+      enabled: true,
+      level: 2,
+      name: "Team Defined",
+      scope_query: "kind:service",
+      scorecard_name: "Deployments automated via Deployment Trains",
+    }),
+    type: DatadogAPIClient::V2::RuleType::RULE,
+  }),
+})
+p api_instance.update_scorecard_rule("rule_id", body)

examples/v2/service-scorecards/UpdateScorecardRule.rb → examples/v2/scorecards/UpdateScorecardRule_1831541184.rb

@@ -1,10 +1,7 @@
 # Update an existing rule returns "Rule updated successfully" response
 
 require "datadog_api_client"
-DatadogAPIClient.configure do |config|
-  config.unstable_operations["v2.update_scorecard_rule".to_sym] = true
-end
-api_instance = DatadogAPIClient::V2::ServiceScorecardsAPI.new
+api_instance = DatadogAPIClient::V2::ScorecardsAPI.new
 
 # there is a valid "create_scorecard_rule" in the system
 CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME = ENV["CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME"]
@@ -13,7 +10,8 @@
 
 body = DatadogAPIClient::V2::UpdateRuleRequest.new({
   data: DatadogAPIClient::V2::UpdateRuleRequestData.new({
-    attributes: DatadogAPIClient::V2::RuleAttributes.new({
+    type: DatadogAPIClient::V2::RuleType::RULE,
+    attributes: DatadogAPIClient::V2::RuleAttributesRequest.new({
       enabled: true,
       name: CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_NAME,
       scorecard_name: CREATE_SCORECARD_RULE_DATA_ATTRIBUTES_SCORECARD_NAME,

features/scenarios_model_mapping.rb

@@ -3638,6 +3638,28 @@
             "page_size" => "Integer",
             "filter_application_id" => "String",
     },
+    "v2.ListScorecardCampaigns" => {
+            "page_limit" => "Integer",
+            "page_offset" => "Integer",
+            "filter_campaign_name" => "String",
+            "filter_campaign_status" => "String",
+            "filter_campaign_owner" => "String",
+    },
+    "v2.CreateScorecardCampaign" => {
+            "body" => "CreateCampaignRequest",
+    },
+    "v2.DeleteScorecardCampaign" => {
+            "campaign_id" => "String",
+    },
+    "v2.GetScorecardCampaign" => {
+            "campaign_id" => "String",
+            "include" => "String",
+            "include_meta" => "Boolean",
+    },
+    "v2.UpdateScorecardCampaign" => {
+            "campaign_id" => "String",
+            "body" => "UpdateCampaignRequest",
+    },
     "v2.ListScorecardOutcomes" => {
             "page_size" => "Integer",
             "page_offset" => "Integer",
@@ -3650,7 +3672,7 @@
             "filter_rule_id" => "String",
             "filter_rule_name" => "String",
     },
-    "v2.UpdateScorecardOutcomesAsync" => {
+    "v2.UpdateScorecardOutcomes" => {
             "body" => "UpdateOutcomesAsyncRequest",
     },
     "v2.CreateScorecardOutcomesBatch" => {
@@ -3678,6 +3700,13 @@
             "rule_id" => "String",
             "body" => "UpdateRuleRequest",
     },
+    "v2.ListScorecards" => {
+            "page_offset" => "Integer",
+            "page_size" => "Integer",
+            "filter_scorecard_id" => "String",
+            "filter_scorecard_name" => "String",
+            "filter_scorecard_description" => "String",
+    },
     "v2.UnassignSeatsUser" => {
             "body" => "UnassignSeatsUserRequest",
     },

features/v2/given.json

@@ -1087,7 +1087,7 @@
     ],
     "step": "there is a valid \"create_scorecard_rule\" in the system",
     "key": "create_scorecard_rule",
-    "tag": "Service Scorecards",
+    "tag": "Scorecards",
     "operationId": "CreateScorecardRule"
   },
   {