Add a new end point that allows the SPA recommendation to be called without the shard parameter (#1142)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -42828,6 +42828,9 @@ components:
       description: Attributes of the SPA Recommendation resource. Contains recommendations
         for both driver and executor components.
       properties:
+        confidence_level:
+          format: double
+          type: number
         driver:
           $ref: '#/components/schemas/ComponentRecommendation'
         executor:
@@ -86626,13 +86629,79 @@ paths:
       x-unstable: '**Note**: This feature is in private beta. To request access, use
         the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
         docs.'
-  /api/v2/spa/recommendations/{service}/{shard}:
+  /api/v2/spa/recommendations/{service}:
     get:
-      description: Retrieve resource recommendations for a Spark job. The caller (Spark
-        Gateway or DJM UI) provides a service name and shard identifier, and SPA returns
-        structured recommendations for driver and executor resources.
+      description: This endpoint is currently experimental and restricted to Datadog
+        internal use only. Retrieve resource recommendations for a Spark job. The
+        caller (Spark Gateway or DJM UI) provides a service name and SPA returns structured
+        recommendations for driver and executor resources. The version with a shard
+        should be preferred, where possible, as it gives more accurate results.
       operationId: GetSPARecommendations
       parameters:
+      - description: The recommendation service should not use its metrics cache.
+        in: query
+        name: bypass_cache
+        schema:
+          type: string
+      - description: The service name for a spark job.
+        in: path
+        name: service
+        required: true
+        schema:
+          type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              example:
+                data:
+                  attributes:
+                    driver:
+                      estimation:
+                        cpu:
+                          max: 1500
+                          p75: 1000
+                          p95: 1200
+                        ephemeral_storage: 896
+                        heap: 6144
+                        memory: 7168
+                        overhead: 1024
+                    executor:
+                      estimation:
+                        cpu:
+                          max: 2000
+                          p75: 1200
+                          p95: 1500
+                        ephemeral_storage: 512
+                        heap: 3072
+                        memory: 4096
+                        overhead: 1024
+                  id: dedupeactivecontexts:adp_dedupeactivecontexts_org2
+                  type: recommendation
+              schema:
+                $ref: '#/components/schemas/RecommendationDocument'
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - AuthZ: []
+      summary: Get SPA Recommendations
+      tags:
+      - Spa
+      x-unstable: '**Note**: This endpoint is in preview and may change in the future.
+        It is not yet recommended for production use.'
+  /api/v2/spa/recommendations/{service}/{shard}:
+    get:
+      description: This endpoint is currently experimental and restricted to Datadog
+        internal use only. Retrieve resource recommendations for a Spark job. The
+        caller (Spark Gateway or DJM UI) provides a service name and shard identifier,
+        and SPA returns structured recommendations for driver and executor resources.
+      operationId: GetSPARecommendationsWithShard
+      parameters:
       - description: The shard tag for a spark job, which differentiates jobs within
           the same service that have different resource needs
         in: path
@@ -86646,6 +86715,11 @@ paths:
         required: true
         schema:
           type: string
+      - description: The recommendation service should not use its metrics cache.
+        in: query
+        name: bypass_cache
+        schema:
+          type: string
       responses:
         '200':
           content:
@@ -86684,11 +86758,13 @@ paths:
           $ref: '#/components/responses/NotAuthorizedResponse'
         '429':
           $ref: '#/components/responses/TooManyRequestsResponse'
-      summary: Get SPA Recommendations
+      security:
+      - AuthZ: []
+      summary: Get SPA Recommendations with a shard parameter
       tags:
       - Spa
-      x-unstable: '**Note**: This endpoint is in public beta and may change in the
-        future. It is not yet recommended for production use.'
+      x-unstable: '**Note**: This endpoint is in preview and may change in the future.
+        It is not yet recommended for production use.'
   /api/v2/spans/analytics/aggregate:
     post:
       description: 'The API endpoint to aggregate spans into buckets and compute metrics

examples/v2_spa_GetSPARecommendations.rs

@@ -1,5 +1,6 @@
 // Get SPA Recommendations returns "OK" response
 use datadog_api_client::datadog;
+use datadog_api_client::datadogV2::api_spa::GetSPARecommendationsOptionalParams;
 use datadog_api_client::datadogV2::api_spa::SpaAPI;
 
 #[tokio::main]
@@ -8,7 +9,10 @@ async fn main() {
     configuration.set_unstable_operation_enabled("v2.GetSPARecommendations", true);
     let api = SpaAPI::with_config(configuration);
     let resp = api
-        .get_spa_recommendations("shard".to_string(), "service".to_string())
+        .get_spa_recommendations(
+            "service".to_string(),
+            GetSPARecommendationsOptionalParams::default(),
+        )
         .await;
     if let Ok(value) = resp {
         println!("{:#?}", value);

examples/v2_spa_GetSPARecommendationsWithShard.rs

@@ -0,0 +1,23 @@
+// Get SPA Recommendations with a shard parameter returns "OK" response
+use datadog_api_client::datadog;
+use datadog_api_client::datadogV2::api_spa::GetSPARecommendationsWithShardOptionalParams;
+use datadog_api_client::datadogV2::api_spa::SpaAPI;
+
+#[tokio::main]
+async fn main() {
+    let mut configuration = datadog::Configuration::new();
+    configuration.set_unstable_operation_enabled("v2.GetSPARecommendationsWithShard", true);
+    let api = SpaAPI::with_config(configuration);
+    let resp = api
+        .get_spa_recommendations_with_shard(
+            "shard".to_string(),
+            "service".to_string(),
+            GetSPARecommendationsWithShardOptionalParams::default(),
+        )
+        .await;
+    if let Ok(value) = resp {
+        println!("{:#?}", value);
+    } else {
+        println!("{:#?}", resp.unwrap_err());
+    }
+}

src/datadog/configuration.rs

@@ -276,6 +276,7 @@ impl Default for Configuration {
             ("v2.get_slo_report".to_owned(), false),
             ("v2.get_slo_report_job_status".to_owned(), false),
             ("v2.get_spa_recommendations".to_owned(), false),
+            ("v2.get_spa_recommendations_with_shard".to_owned(), false),
             ("v2.create_sca_resolve_vulnerable_symbols".to_owned(), false),
             ("v2.create_sca_result".to_owned(), false),
             ("v2.add_member_team".to_owned(), false),