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

 Sync with OpenAPI definition

Author: bmeck

openapi.json

@@ -2554,7 +2554,20 @@
                       "props": {
                         "type": "object",
                         "additionalProperties": false,
-                        "properties": {}
+                        "properties": {
+                          "key": {
+                            "type": "string",
+                            "default": ""
+                          },
+                          "description": {
+                            "type": "string",
+                            "default": ""
+                          }
+                        },
+                        "required": [
+                          "description",
+                          "key"
+                        ]
                       },
                       "usage": {
                         "$ref": "#/components/schemas/SocketUsageRef"
@@ -4495,6 +4508,21 @@
                 "$ref": "#/components/schemas/SocketRefPyPI"
               }
             }
+          },
+          {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "go"
+                ]
+              },
+              "value": {
+                "$ref": "#/components/schemas/SocketRefGo"
+              }
+            }
           }
         ]
       },
@@ -4627,6 +4655,26 @@
         "required": [
           "package"
         ]
+      },
+      "SocketRefGo": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "package": {
+            "type": "string",
+            "default": ""
+          },
+          "version": {
+            "type": "string",
+            "default": ""
+          },
+          "file": {
+            "$ref": "#/components/schemas/SocketRefFile"
+          }
+        },
+        "required": [
+          "package"
+        ]
       }
     },
     "securitySchemes": {
@@ -5300,28 +5348,40 @@
                           },
                           "settings": {
                             "type": "object",
-                            "properties": {
-                              "deferTo": {
-                                "type": "string",
-                                "nullable": true
-                              },
-                              "issueRules": {
-                                "type": "object",
-                                "additionalProperties": {
+                            "additionalProperties": {
+                              "type": "object",
+                              "properties": {
+                                "deferTo": {
+                                  "type": "string",
+                                  "nullable": true
+                                },
+                                "issueRules": {
                                   "type": "object",
-                                  "properties": {
-                                    "action": {
-                                      "type": "string",
-                                      "enum": [
-                                        "defer",
-                                        "error",
-                                        "ignore",
-                                        "warn"
-                                      ]
-                                    }
+                                  "nullable": false,
+                                  "additionalProperties": {
+                                    "type": "object",
+                                    "nullable": false,
+                                    "properties": {
+                                      "action": {
+                                        "type": "string",
+                                        "enum": [
+                                          "defer",
+                                          "error",
+                                          "ignore",
+                                          "warn"
+                                        ]
+                                      }
+                                    },
+                                    "required": [
+                                      "action"
+                                    ]
                                   }
                                 }
-                              }
+                              },
+                              "required": [
+                                "deferTo",
+                                "issueRules"
+                              ]
                             }
                           }
                         },

types/api.d.ts

@@ -717,7 +717,12 @@ export interface components {
       value?: components["schemas"]["SocketIssueBasics"] & {
         /** @default */
         description: string;
-        props: Record<string, never>;
+        props: {
+          /** @default */
+          key: string;
+          /** @default */
+          description: string;
+        };
         usage?: components["schemas"]["SocketUsageRef"];
       };
     }) | ({
@@ -1214,6 +1219,10 @@ export interface components {
       /** @enum {string} */
       type?: "pypi";
       value?: components["schemas"]["SocketRefPyPI"];
+    } | {
+      /** @enum {string} */
+      type?: "go";
+      value?: components["schemas"]["SocketRefGo"];
     };
     SocketRefTextRange: {
       /** @default 0 */
@@ -1261,6 +1270,13 @@ export interface components {
       artifact?: string;
       file?: components["schemas"]["SocketRefFile"];
     };
+    SocketRefGo: {
+      /** @default */
+      package: string;
+      /** @default */
+      version?: string;
+      file?: components["schemas"]["SocketRefFile"];
+    };
   };
   responses: {
     /** @description Bad request */
@@ -1645,13 +1661,15 @@ export interface operations {
                 /** @default */
                 start: string | null;
                 settings: {
-                  deferTo?: string | null;
-                  issueRules?: {
-                    [key: string]: ({
-                      /** @enum {string} */
-                      action?: "defer" | "error" | "ignore" | "warn";
-                    }) | undefined;
-                  };
+                  [key: string]: ({
+                    deferTo: string | null;
+                    issueRules: {
+                      [key: string]: ({
+                        /** @enum {string} */
+                        action: "defer" | "error" | "ignore" | "warn";
+                      }) | undefined;
+                    };
+                  }) | undefined;
                 };
               })[];
           };