Merge pull request #210 from SocketDev/automated/open-api

 Sync with OpenAPI definition

Author: charliegerard

openapi.json

@@ -7241,7 +7241,7 @@
             ]
           }
         ],
-        "description": "Batch retrieval of package metadata and alerts by PURL strings. Compatible witch CycloneDX reports.\n\nPackage URLs (PURLs) are an ecosystem agnostic way to identify packages.\nCycloneDX SBOMs use the purl format to identify components.\nThis endpoint supports fetching metadata and alerts for multiple packages at once by passing an array of purl strings, or by passing an entire CycloneDX report.\n\nMore information on purl and CycloneDX:\n\n- [`purl` Spec](https://github.com/package-url/purl-spec)\n- [CycloneDX Spec](https://cyclonedx.org/specification/overview/#components)\n\n## Examples:\n\n### Looking up an npm package:\n\n```json\n{\n  \"components\": [\n    {\n      \"purl\": \"pkg:npm/[email protected]\"\n    }\n  ]\n}\n```\n\n### Looking up an PyPi package:\n\n```json\n{\n  \"components\": [\n    {\n      \"purl\": \"pkg:pypi/[email protected]\"\n    }\n  ]\n}\n```\n\n### Looking up a Maven package:\n\n```json\n{\n  \"components\": [\n    {\n      \"purl\": \"pkg:maven/log4j/[email protected]\"\n    }\n  ]\n}\n```\n\n### Batch lookup\n\n```json\n{\n  \"components\": [\n    {\n      \"purl\": \"pkg:npm/[email protected]\"\n    },\n    {\n      \"purl\": \"pkg:pypi/[email protected]\"\n    },\n    {\n      \"purl\": \"pkg:maven/log4j/[email protected]\"\n    }\n  ]\n}\n```\n\nThis endpoint consumes 100 units of your quota.\n\nThis endpoint requires the following org token scopes:\n- packages:list",
+        "description": "Batch retrieval of package metadata and alerts by PURL strings. Compatible witch CycloneDX reports.\n\nPackage URLs (PURLs) are an ecosystem agnostic way to identify packages.\nCycloneDX SBOMs use the purl format to identify components.\nThis endpoint supports fetching metadata and alerts for multiple packages at once by passing an array of purl strings, or by passing an entire CycloneDX report.\n\nMore information on purl and CycloneDX:\n\n- [`purl` Spec](https://github.com/package-url/purl-spec)\n- [CycloneDX Spec](https://cyclonedx.org/specification/overview/#components)\n\nThis endpoint returns the latest available alert data for artifacts in the batch (stale while revalidate).\nActively running analysis will be returned when available on subsequent runs.\n\n## Examples:\n\n### Looking up an npm package:\n\n```json\n{\n  \"components\": [\n    {\n      \"purl\": \"pkg:npm/[email protected]\"\n    }\n  ]\n}\n```\n\n### Looking up an PyPi package:\n\n```json\n{\n  \"components\": [\n    {\n      \"purl\": \"pkg:pypi/[email protected]\"\n    }\n  ]\n}\n```\n\n### Looking up a Maven package:\n\n```json\n{\n  \"components\": [\n    {\n      \"purl\": \"pkg:maven/log4j/[email protected]\"\n    }\n  ]\n}\n```\n\n### Batch lookup\n\n```json\n{\n  \"components\": [\n    {\n      \"purl\": \"pkg:npm/[email protected]\"\n    },\n    {\n      \"purl\": \"pkg:pypi/[email protected]\"\n    },\n    {\n      \"purl\": \"pkg:maven/log4j/[email protected]\"\n    }\n  ]\n}\n```\n\nThis endpoint consumes 100 units of your quota.\n\nThis endpoint requires the following org token scopes:\n- packages:list",
         "responses": {
           "200": {
             "content": {
@@ -8172,7 +8172,7 @@
             ]
           }
         ],
-        "description": "Stream all SBOM artifacts for a full scan.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- full-scans:list",
+        "description": "Stream all SBOM artifacts for a full scan.\n\nThis endpoint returns the latest, available alert data for artifacts in the full scan (stale while revalidate).\nActively running analysis will be returned when available on subsequent runs.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- full-scans:list",
         "responses": {
           "200": {
             "content": {
@@ -10446,14 +10446,15 @@
               }
             }
           },
+          "description": "Array of organization selector objects (with `organization` field holding the organization ID) to get settings for",
           "required": false
         },
         "security": [
           {
             "basicAuth": []
           }
         ],
-        "description": "Get your current settings the requested organizations and default settings to allow deferrals.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- Any",
+        "description": "Get current settings for the requested organizations and default settings to allow deferrals.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- Any",
         "responses": {
           "200": {
             "content": {
@@ -10556,7 +10557,7 @@
                 }
               }
             },
-            "description": "Organization settings"
+            "description": "Organization settings. Returned object contains default issue rules and an array of entries, with each entry representing an organization's settings."
           },
           "401": {
             "$ref": "#/components/responses/SocketUnauthorized"

types/api.d.ts

@@ -19,6 +19,9 @@ export interface paths {
      * - [`purl` Spec](https://github.com/package-url/purl-spec)
      * - [CycloneDX Spec](https://cyclonedx.org/specification/overview/#components)
      *
+     * This endpoint returns the latest available alert data for artifacts in the batch (stale while revalidate).
+     * Actively running analysis will be returned when available on subsequent runs.
+     *
      * ## Examples:
      *
      * ### Looking up an npm package:
@@ -145,6 +148,9 @@ export interface paths {
      * Stream full scan
      * @description Stream all SBOM artifacts for a full scan.
      *
+     * This endpoint returns the latest, available alert data for artifacts in the full scan (stale while revalidate).
+     * Actively running analysis will be returned when available on subsequent runs.
+     *
      * This endpoint consumes 1 unit of your quota.
      *
      * This endpoint requires the following org token scopes:
@@ -402,7 +408,7 @@ export interface paths {
   "/settings": {
     /**
      * Calculate settings
-     * @description Get your current settings the requested organizations and default settings to allow deferrals.
+     * @description Get current settings for the requested organizations and default settings to allow deferrals.
      *
      * This endpoint consumes 1 unit of your quota.
      *
@@ -2292,6 +2298,9 @@ export interface operations {
    * - [`purl` Spec](https://github.com/package-url/purl-spec)
    * - [CycloneDX Spec](https://cyclonedx.org/specification/overview/#components)
    *
+   * This endpoint returns the latest available alert data for artifacts in the batch (stale while revalidate).
+   * Actively running analysis will be returned when available on subsequent runs.
+   *
    * ## Examples:
    *
    * ### Looking up an npm package:
@@ -2681,6 +2690,9 @@ export interface operations {
    * Stream full scan
    * @description Stream all SBOM artifacts for a full scan.
    *
+   * This endpoint returns the latest, available alert data for artifacts in the full scan (stale while revalidate).
+   * Actively running analysis will be returned when available on subsequent runs.
+   *
    * This endpoint consumes 1 unit of your quota.
    *
    * This endpoint requires the following org token scopes:
@@ -3831,14 +3843,15 @@ export interface operations {
   };
   /**
    * Calculate settings
-   * @description Get your current settings the requested organizations and default settings to allow deferrals.
+   * @description Get current settings for the requested organizations and default settings to allow deferrals.
    *
    * This endpoint consumes 1 unit of your quota.
    *
    * This endpoint requires the following org token scopes:
    * - Any
    */
   postSettings: {
+    /** @description Array of organization selector objects (with `organization` field holding the organization ID) to get settings for */
     requestBody?: {
       content: {
         "application/json": {
@@ -3848,7 +3861,7 @@ export interface operations {
       };
     };
     responses: {
-      /** @description Organization settings */
+      /** @description Organization settings. Returned object contains default issue rules and an array of entries, with each entry representing an organization's settings. */
       200: {
         content: {
           "application/json": {