Add OpenAPI documentation for scorecards endpoints

docs/datadog_api_client.v2.api.rst

@@ -585,6 +585,13 @@ datadog\_api\_client.v2.api.rum\_retention\_filters\_api module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.api.scorecards\_api module
+--------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.api.scorecards_api
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.api.seats\_api module
 ---------------------------------------------
 
@@ -634,13 +641,6 @@ datadog\_api\_client.v2.api.service\_now\_integration\_api module
    :members:
    :show-inheritance:
 
-datadog\_api\_client.v2.api.service\_scorecards\_api module
------------------------------------------------------------
-
-.. automodule:: datadog_api_client.v2.api.service_scorecards_api
-   :members:
-   :show-inheritance:
-
 datadog\_api\_client.v2.api.software\_catalog\_api module
 ---------------------------------------------------------
 

docs/datadog_api_client.v2.model.rst

@@ -3140,6 +3140,41 @@ datadog\_api\_client.v2.model.calculated\_field module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.campaign\_response module
+-------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.campaign_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.campaign\_response\_attributes module
+-------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.campaign_response_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.campaign\_response\_data module
+-------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.campaign_response_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.campaign\_status module
+-----------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.campaign_status
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.campaign\_type module
+---------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.campaign_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.cancel\_data\_deletion\_response\_body module
 ---------------------------------------------------------------------------
 
@@ -5989,6 +6024,27 @@ datadog\_api\_client.v2.model.create\_attachment\_request\_data\_attributes\_att
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.create\_campaign\_request module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.create_campaign_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.create\_campaign\_request\_attributes module
+--------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.create_campaign_request_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.create\_campaign\_request\_data module
+--------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.create_campaign_request_data
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.create\_case\_request\_array module
 -----------------------------------------------------------------
 
@@ -15271,6 +15327,13 @@ datadog\_api\_client.v2.model.list\_assets\_sbo\_ms\_response module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.list\_campaigns\_response module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.list_campaigns_response
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.list\_connections\_response module
 ----------------------------------------------------------------
 
@@ -15502,6 +15565,13 @@ datadog\_api\_client.v2.model.list\_rules\_response\_links module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.list\_scorecards\_response module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.list_scorecards_response
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.list\_security\_findings\_response module
 -----------------------------------------------------------------------
 
@@ -21067,6 +21137,13 @@ datadog\_api\_client.v2.model.page\_urgency module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.paginated\_response\_meta module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.paginated_response_meta
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.pagination module
 -----------------------------------------------
 
@@ -23636,6 +23713,13 @@ datadog\_api\_client.v2.model.rule\_attributes module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.rule\_attributes\_request module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.rule_attributes_request
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.rule\_outcome\_relationships module
 -----------------------------------------------------------------
 
@@ -25134,6 +25218,27 @@ datadog\_api\_client.v2.model.schedule\_user\_type module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.scorecard\_list\_response\_attributes module
+--------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.scorecard_list_response_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.scorecard\_list\_response\_data module
+--------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.scorecard_list_response_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.scorecard\_list\_type module
+----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.scorecard_list_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.scorecard\_type module
 ----------------------------------------------------
 
@@ -30825,6 +30930,27 @@ datadog\_api\_client.v2.model.update\_apps\_datastore\_request\_data\_attributes
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.update\_campaign\_request module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.update_campaign_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.update\_campaign\_request\_attributes module
+--------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.update_campaign_request_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.update\_campaign\_request\_data module
+--------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.update_campaign_request_data
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.update\_connection\_request module
 ----------------------------------------------------------------
 

examples/v2/scorecards/CreateScorecardCampaign.py

@@ -0,0 +1,41 @@
+"""
+Create a new campaign returns "Created" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.scorecards_api import ScorecardsApi
+from datadog_api_client.v2.model.campaign_status import CampaignStatus
+from datadog_api_client.v2.model.campaign_type import CampaignType
+from datadog_api_client.v2.model.create_campaign_request import CreateCampaignRequest
+from datadog_api_client.v2.model.create_campaign_request_attributes import CreateCampaignRequestAttributes
+from datadog_api_client.v2.model.create_campaign_request_data import CreateCampaignRequestData
+from datetime import datetime
+from dateutil.tz import tzutc
+
+body = CreateCampaignRequest(
+    data=CreateCampaignRequestData(
+        attributes=CreateCampaignRequestAttributes(
+            description="Campaign to improve security posture for Q1 2024.",
+            due_date=datetime(2024, 3, 31, 23, 59, 59, tzinfo=tzutc()),
+            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=datetime(2024, 1, 1, 0, 0, tzinfo=tzutc()),
+            status=CampaignStatus.IN_PROGRESS,
+        ),
+        type=CampaignType.CAMPAIGN,
+    ),
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = ScorecardsApi(api_client)
+    response = api_instance.create_scorecard_campaign(body=body)
+
+    print(response)

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

@@ -2,26 +2,22 @@
 Create outcomes batch returns "OK" response
 """
 
-from os import environ
 from datadog_api_client import ApiClient, Configuration
-from datadog_api_client.v2.api.service_scorecards_api import ServiceScorecardsApi
+from datadog_api_client.v2.api.scorecards_api import ScorecardsApi
 from datadog_api_client.v2.model.outcomes_batch_attributes import OutcomesBatchAttributes
 from datadog_api_client.v2.model.outcomes_batch_request import OutcomesBatchRequest
 from datadog_api_client.v2.model.outcomes_batch_request_data import OutcomesBatchRequestData
 from datadog_api_client.v2.model.outcomes_batch_request_item import OutcomesBatchRequestItem
 from datadog_api_client.v2.model.outcomes_batch_type import OutcomesBatchType
 from datadog_api_client.v2.model.state import State
 
-# there is a valid "create_scorecard_rule" in the system
-CREATE_SCORECARD_RULE_DATA_ID = environ["CREATE_SCORECARD_RULE_DATA_ID"]
-
 body = OutcomesBatchRequest(
     data=OutcomesBatchRequestData(
         attributes=OutcomesBatchAttributes(
             results=[
                 OutcomesBatchRequestItem(
                     remarks='See: <a href="https://app.datadoghq.com/services">Services</a>',
-                    rule_id=CREATE_SCORECARD_RULE_DATA_ID,
+                    rule_id="q8MQxk8TCqrHnWkx",
                     service_name="my-service",
                     state=State.PASS,
                 ),
@@ -34,7 +30,7 @@
 configuration = Configuration()
 configuration.unstable_operations["create_scorecard_outcomes_batch"] = True
 with ApiClient(configuration) as api_client:
-    api_instance = ServiceScorecardsApi(api_client)
+    api_instance = ScorecardsApi(api_client)
     response = api_instance.create_scorecard_outcomes_batch(body=body)
 
     print(response)

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

@@ -3,27 +3,28 @@
 """
 
 from datadog_api_client import ApiClient, Configuration
-from datadog_api_client.v2.api.service_scorecards_api import ServiceScorecardsApi
+from datadog_api_client.v2.api.scorecards_api import ScorecardsApi
 from datadog_api_client.v2.model.create_rule_request import CreateRuleRequest
 from datadog_api_client.v2.model.create_rule_request_data import CreateRuleRequestData
-from datadog_api_client.v2.model.rule_attributes import RuleAttributes
+from datadog_api_client.v2.model.rule_attributes_request import RuleAttributesRequest
 from datadog_api_client.v2.model.rule_type import RuleType
 
 body = CreateRuleRequest(
     data=CreateRuleRequestData(
-        attributes=RuleAttributes(
+        attributes=RuleAttributesRequest(
             enabled=True,
-            name="Example-Service-Scorecard",
-            scorecard_name="Observability Best Practices",
+            level=2,
+            name="Team Defined",
+            scope_query="kind:service",
+            scorecard_name="Deployments automated via Deployment Trains",
         ),
         type=RuleType.RULE,
     ),
 )
 
 configuration = Configuration()
-configuration.unstable_operations["create_scorecard_rule"] = True
 with ApiClient(configuration) as api_client:
-    api_instance = ServiceScorecardsApi(api_client)
+    api_instance = ScorecardsApi(api_client)
     response = api_instance.create_scorecard_rule(body=body)
 
     print(response)

examples/v2/scorecards/DeleteScorecardCampaign.py

@@ -0,0 +1,13 @@
+"""
+Delete a campaign returns "No Content" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.scorecards_api import ScorecardsApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = ScorecardsApi(api_client)
+    api_instance.delete_scorecard_campaign(
+        campaign_id="c10ODp0VCrrIpXmz",
+    )

examples/v2/scorecards/DeleteScorecardRule.py

@@ -0,0 +1,13 @@
+"""
+Delete a rule returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.scorecards_api import ScorecardsApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = ScorecardsApi(api_client)
+    api_instance.delete_scorecard_rule(
+        rule_id="rule_id",
+    )

examples/v2/scorecards/GetScorecardCampaign.py

@@ -0,0 +1,15 @@
+"""
+Get a campaign returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.scorecards_api import ScorecardsApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = ScorecardsApi(api_client)
+    response = api_instance.get_scorecard_campaign(
+        campaign_id="c10ODp0VCrrIpXmz",
+    )
+
+    print(response)

examples/v2/scorecards/ListScorecardCampaigns.py

@@ -0,0 +1,13 @@
+"""
+List all campaigns returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.scorecards_api import ScorecardsApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = ScorecardsApi(api_client)
+    response = api_instance.list_scorecard_campaigns()
+
+    print(response)

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

@@ -3,12 +3,11 @@
 """
 
 from datadog_api_client import ApiClient, Configuration
-from datadog_api_client.v2.api.service_scorecards_api import ServiceScorecardsApi
+from datadog_api_client.v2.api.scorecards_api import ScorecardsApi
 
 configuration = Configuration()
-configuration.unstable_operations["list_scorecard_outcomes"] = True
 with ApiClient(configuration) as api_client:
-    api_instance = ServiceScorecardsApi(api_client)
+    api_instance = ScorecardsApi(api_client)
     response = api_instance.list_scorecard_outcomes()
 
     print(response)