fix(openapi): sync with openapi definition (#232)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
SocketDev · Nov 7, 2024 · cf531c7 · cf531c7
1 parent 4b4586a
commit cf531c7
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 22 deletions.
diff --git a/openapi.json b/openapi.json
@@ -7716,6 +7716,7 @@
                 "SyncOrganization",
                 "TransferOwnership",
                 "UpdateAlertTriage",
+                "UpdateApiTokenCommitter",
                 "UpdateApiTokenName",
                 "UpdateApiTokenScopes",
                 "UpdateApiTokenVisibility",
@@ -8862,9 +8863,9 @@
     "/orgs/{org_slug}/full-scans/diff": {
       "get": {
         "tags": [
-          "Diff Scans"
+          "Full Scans"
         ],
-        "summary": "Stream diff scan",
+        "summary": "Diff Full Scans",
         "operationId": "GetOrgDiffScan",
         "parameters": [
           {
@@ -8893,16 +8894,6 @@
             "schema": {
               "type": "string"
             }
-          },
-          {
-            "name": "preview",
-            "in": "query",
-            "required": true,
-            "description": "Create a diff-scan that is not persisted.",
-            "schema": {
-              "type": "boolean",
-              "default": false
-            }
           }
         ],
         "security": [
@@ -8912,7 +8903,7 @@
             ]
           }
         ],
-        "description": "Stream a diff scan between two full scans. Returns a diff scan.\n\nThis endpoint consumes 1 unit of your quota.\n\nThis endpoint requires the following org token scopes:\n- full-scans:list",
+        "description": "Get the difference between two Full Scans.\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": {
@@ -11093,7 +11084,7 @@
                 }
               }
             },
-            "description": "Returns a diff scan. The authenticated user must be a member of the organization."
+            "description": "The differnce between the two provided Full Scans."
           },
           "400": {
             "$ref": "#/components/responses/SocketBadRequest"

diff --git a/types/api.d.ts b/types/api.d.ts
@@ -335,8 +335,8 @@ export interface paths {
   };
   "/orgs/{org_slug}/full-scans/diff": {
     /**
-     * Stream diff scan
-     * @description Stream a diff scan between two full scans. Returns a diff scan.
+     * Diff Full Scans
+     * @description Get the difference between two Full Scans.
      *
      * This endpoint consumes 1 unit of your quota.
      *
@@ -2865,7 +2865,7 @@ export interface operations {
     parameters: {
       query?: {
         /** @description Filter audit log events by type. Omit for all types. */
-        type?: "BookDemo" | "CancelInvitation" | "ChangeMemberRole" | "ChangePlanSubscriptionSeats" | "ContactForm" | "CreateApiToken" | "CreateUser" | "GithubAppInstallation" | "JoinOrganization" | "JoinOrganizationByVcs" | "LinkAccount" | "RemoveMember" | "ResetInvitationLink" | "ResetOrganizationSettingToDefault" | "RotateApiToken" | "SendInvitation" | "SignIn" | "SignOut" | "Subscribe" | "SyncOrganization" | "TransferOwnership" | "UpdateAlertTriage" | "UpdateApiTokenName" | "UpdateApiTokenScopes" | "UpdateApiTokenVisibility" | "UpdateOrganizationSetting" | "UpgradeOrganizationPlan" | "VerifiedEmail" | "DeleteRepository" | "DeleteReport";
+        type?: "BookDemo" | "CancelInvitation" | "ChangeMemberRole" | "ChangePlanSubscriptionSeats" | "ContactForm" | "CreateApiToken" | "CreateUser" | "GithubAppInstallation" | "JoinOrganization" | "JoinOrganizationByVcs" | "LinkAccount" | "RemoveMember" | "ResetInvitationLink" | "ResetOrganizationSettingToDefault" | "RotateApiToken" | "SendInvitation" | "SignIn" | "SignOut" | "Subscribe" | "SyncOrganization" | "TransferOwnership" | "UpdateAlertTriage" | "UpdateApiTokenCommitter" | "UpdateApiTokenName" | "UpdateApiTokenScopes" | "UpdateApiTokenVisibility" | "UpdateOrganizationSetting" | "UpgradeOrganizationPlan" | "VerifiedEmail" | "DeleteRepository" | "DeleteReport";
         /** @description Number of events per page */
         per_page?: number;
         /** @description Page token */
@@ -3291,8 +3291,8 @@ export interface operations {
     };
   };
   /**
-   * Stream diff scan
-   * @description Stream a diff scan between two full scans. Returns a diff scan.
+   * Diff Full Scans
+   * @description Get the difference between two Full Scans.
    *
    * This endpoint consumes 1 unit of your quota.
    *
@@ -3306,16 +3306,14 @@ export interface operations {
         before: string;
         /** @description The base full scan ID */
         after: string;
-        /** @description Create a diff-scan that is not persisted. */
-        preview: boolean;
       };
       path: {
         /** @description The slug of the organization */
         org_slug: string;
       };
     };
     responses: {
-      /** @description Returns a diff scan. The authenticated user must be a member of the organization. */
+      /** @description The differnce between the two provided Full Scans. */
       200: {
         content: {
           "application/json": {