Add endpoints for Software Composition Analysis (#2938)

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

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

.generator/schemas/v2/openapi.yaml

@@ -39409,6 +39409,95 @@ components:
       type: string
       x-enum-varnames:
       - RULESET
+    ResolveVulnerableSymbolsRequest:
+      properties:
+        data:
+          $ref: '#/components/schemas/ResolveVulnerableSymbolsRequestData'
+      type: object
+    ResolveVulnerableSymbolsRequestData:
+      properties:
+        attributes:
+          $ref: '#/components/schemas/ResolveVulnerableSymbolsRequestDataAttributes'
+        id:
+          type: string
+        type:
+          $ref: '#/components/schemas/ResolveVulnerableSymbolsRequestDataType'
+      required:
+      - type
+      type: object
+    ResolveVulnerableSymbolsRequestDataAttributes:
+      properties:
+        purls:
+          items:
+            type: string
+          type: array
+      type: object
+    ResolveVulnerableSymbolsRequestDataType:
+      default: resolve-vulnerable-symbols-request
+      enum:
+      - resolve-vulnerable-symbols-request
+      example: resolve-vulnerable-symbols-request
+      type: string
+      x-enum-varnames:
+      - RESOLVE_VULNERABLE_SYMBOLS_REQUEST
+    ResolveVulnerableSymbolsResponse:
+      properties:
+        data:
+          $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseData'
+      type: object
+    ResolveVulnerableSymbolsResponseData:
+      properties:
+        attributes:
+          $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseDataAttributes'
+        id:
+          type: string
+        type:
+          $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseDataType'
+      required:
+      - type
+      type: object
+    ResolveVulnerableSymbolsResponseDataAttributes:
+      properties:
+        results:
+          items:
+            $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseResults'
+          type: array
+      type: object
+    ResolveVulnerableSymbolsResponseDataType:
+      default: resolve-vulnerable-symbols-response
+      enum:
+      - resolve-vulnerable-symbols-response
+      example: resolve-vulnerable-symbols-response
+      type: string
+      x-enum-varnames:
+      - RESOLVE_VULNERABLE_SYMBOLS_RESPONSE
+    ResolveVulnerableSymbolsResponseResults:
+      properties:
+        purl:
+          type: string
+        vulnerable_symbols:
+          items:
+            $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseResultsVulnerableSymbols'
+          type: array
+      type: object
+    ResolveVulnerableSymbolsResponseResultsVulnerableSymbols:
+      properties:
+        advisory_id:
+          type: string
+        symbols:
+          items:
+            $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols'
+          type: array
+      type: object
+    ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols:
+      properties:
+        name:
+          type: string
+        type:
+          type: string
+        value:
+          type: string
+      type: object
     ResourceFilterAttributes:
       description: Attributes of a resource filter.
       example:
@@ -41843,6 +41932,184 @@ components:
           example: report_id
           type: string
       type: object
+    ScaRequest:
+      properties:
+        data:
+          $ref: '#/components/schemas/ScaRequestData'
+      type: object
+    ScaRequestData:
+      properties:
+        attributes:
+          $ref: '#/components/schemas/ScaRequestDataAttributes'
+        id:
+          type: string
+        type:
+          $ref: '#/components/schemas/ScaRequestDataType'
+      required:
+      - type
+      type: object
+    ScaRequestDataAttributes:
+      properties:
+        commit:
+          $ref: '#/components/schemas/ScaRequestDataAttributesCommit'
+        dependencies:
+          items:
+            $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItems'
+          type: array
+        env:
+          type: string
+        files:
+          items:
+            $ref: '#/components/schemas/ScaRequestDataAttributesFilesItems'
+          type: array
+        relations:
+          items:
+            $ref: '#/components/schemas/ScaRequestDataAttributesRelationsItems'
+          type: array
+        repository:
+          $ref: '#/components/schemas/ScaRequestDataAttributesRepository'
+        service:
+          type: string
+        tags:
+          additionalProperties:
+            type: string
+          type: object
+        vulnerabilities:
+          items:
+            $ref: '#/components/schemas/ScaRequestDataAttributesVulnerabilitiesItems'
+          type: array
+      type: object
+    ScaRequestDataAttributesCommit:
+      properties:
+        author_date:
+          type: string
+        author_email:
+          type: string
+        author_name:
+          type: string
+        branch:
+          type: string
+        committer_email:
+          type: string
+        committer_name:
+          type: string
+        sha:
+          type: string
+      type: object
+    ScaRequestDataAttributesDependenciesItems:
+      properties:
+        exclusions:
+          items:
+            type: string
+          type: array
+        group:
+          type: string
+        is_dev:
+          type: boolean
+        is_direct:
+          type: boolean
+        language:
+          type: string
+        locations:
+          items:
+            $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItems'
+          type: array
+        name:
+          type: string
+        package_manager:
+          type: string
+        purl:
+          type: string
+        reachable_symbol_properties:
+          items:
+            $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems'
+          type: array
+        version:
+          type: string
+      type: object
+    ScaRequestDataAttributesDependenciesItemsLocationsItems:
+      properties:
+        block:
+          $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition'
+        name:
+          $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition'
+        namespace:
+          $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition'
+        version:
+          $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition'
+      type: object
+    ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition:
+      properties:
+        end:
+          $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition'
+        file_name:
+          type: string
+        start:
+          $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition'
+      type: object
+    ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition:
+      properties:
+        col:
+          format: int32
+          maximum: 2147483647
+          type: integer
+        line:
+          format: int32
+          maximum: 2147483647
+          type: integer
+      type: object
+    ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems:
+      properties:
+        name:
+          type: string
+        value:
+          type: string
+      type: object
+    ScaRequestDataAttributesFilesItems:
+      properties:
+        name:
+          type: string
+        purl:
+          type: string
+      type: object
+    ScaRequestDataAttributesRelationsItems:
+      properties:
+        depends_on:
+          items:
+            type: string
+          type: array
+        ref:
+          type: string
+      type: object
+    ScaRequestDataAttributesRepository:
+      properties:
+        url:
+          type: string
+      type: object
+    ScaRequestDataAttributesVulnerabilitiesItems:
+      properties:
+        affects:
+          items:
+            $ref: '#/components/schemas/ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems'
+          type: array
+        bom_ref:
+          type: string
+        id:
+          type: string
+      type: object
+    ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems:
+      properties:
+        ref:
+          type: string
+      type: object
+    ScaRequestDataType:
+      default: scarequests
+      enum:
+      - scarequests
+      example: scarequests
+      type: string
+      x-enum-varnames:
+      - SCAREQUESTS
     ScalarColumn:
       description: A single column in a scalar query response.
       oneOf:
@@ -76995,6 +77262,56 @@ paths:
         cursorPath: meta.page.after
         limitParam: body.data.attributes.page.limit
         resultsPath: data
+  /api/v2/static-analysis-sca/dependencies:
+    post:
+      operationId: CreateSCAResult
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ScaRequest'
+        required: true
+      responses:
+        '200':
+          description: OK
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - code_analysis_read
+      summary: Post dependencies for analysis
+      tags:
+      - Static Analysis
+      x-unstable: '**Note**: This endpoint may be subject to changes.'
+  /api/v2/static-analysis-sca/vulnerabilities/resolve-vulnerable-symbols:
+    post:
+      operationId: CreateSCAResolveVulnerableSymbols
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ResolveVulnerableSymbolsRequest'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ResolveVulnerableSymbolsResponse'
+          description: OK
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - code_analysis_read
+      summary: POST request to resolve vulnerable symbols
+      tags:
+      - Static Analysis
+      x-unstable: '**Note**: This endpoint may be subject to changes.'
   /api/v2/synthetics/settings/on_demand_concurrency_cap:
     get:
       description: Get the on-demand concurrency cap.
@@ -80526,6 +80843,8 @@ tags:
     description: Find out more at
     url: https://docs.datadoghq.com/tracing/metrics/metrics_namespace/
   name: Spans Metrics
+- description: API for static analysis
+  name: Static Analysis
 - description: "Datadog Synthetics uses simulated user requests and browser rendering
     to help you ensure uptime,\nidentify regional issues, and track your application
     performance. Datadog Synthetics tests come in\ntwo different flavors, [API tests](https://docs.datadoghq.com/synthetics/api_tests/)\nand

features/v2/static_analysis.feature

@@ -0,0 +1,24 @@
+@endpoint(static-analysis) @endpoint(static-analysis-v2)
+Feature: Static Analysis
+  API for static analysis
+
+  Background:
+    Given a valid "apiKeyAuth" key in the system
+    And a valid "appKeyAuth" key in the system
+    And an instance of "StaticAnalysis" API
+
+  @generated @skip @team:DataDog/k9-vm-sca
+  Scenario: POST request to resolve vulnerable symbols returns "OK" response
+    Given operation "CreateSCAResolveVulnerableSymbols" enabled
+    And new "CreateSCAResolveVulnerableSymbols" request
+    And body with value {"data": {"attributes": {"purls": []}, "type": "resolve-vulnerable-symbols-request"}}
+    When the request is sent
+    Then the response status is 200 OK
+
+  @generated @skip @team:DataDog/k9-vm-sca
+  Scenario: Post dependencies for analysis returns "OK" response
+    Given operation "CreateSCAResult" enabled
+    And new "CreateSCAResult" request
+    And body with value {"data": {"attributes": {"commit": {}, "dependencies": [{"exclusions": [], "locations": [{"block": {"end": {}, "start": {}}, "name": {"end": {}, "start": {}}, "namespace": {"end": {}, "start": {}}, "version": {"end": {}, "start": {}}}], "reachable_symbol_properties": [{}]}], "files": [{}], "relations": [{"depends_on": []}], "repository": {}, "vulnerabilities": [{"affects": [{}]}]}, "type": "scarequests"}}
+    When the request is sent
+    Then the response status is 200 OK

features/v2/undo.json

@@ -3993,6 +3993,18 @@
       "type": "safe"
     }
   },
+  "CreateSCAResult": {
+    "tag": "Static Analysis",
+    "undo": {
+      "type": "safe"
+    }
+  },
+  "CreateSCAResolveVulnerableSymbols": {
+    "tag": "Static Analysis",
+    "undo": {
+      "type": "safe"
+    }
+  },
   "GetOnDemandConcurrencyCap": {
     "tag": "Synthetics",
     "undo": {

packages/datadog-api-client/README.md

@@ -433,6 +433,7 @@ apiInstance
 | Spa | @datadog/datadog-api-client-spa | [README.md](../../services/spa/README.md) |
 | Spans | @datadog/datadog-api-client-spans | [README.md](../../services/spans/README.md) |
 | Spans Metrics | @datadog/datadog-api-client-spans-metrics | [README.md](../../services/spans-metrics/README.md) |
+| Static Analysis | @datadog/datadog-api-client-static-analysis | [README.md](../../services/static-analysis/README.md) |
 | Synthetics | @datadog/datadog-api-client-synthetics | [README.md](../../services/synthetics/README.md) |
 | Tags | @datadog/datadog-api-client-tags | [README.md](../../services/tags/README.md) |
 | Teams | @datadog/datadog-api-client-teams | [README.md](../../services/teams/README.md) |