docs: add API docs for /syms/rescan route

blacktop · Sep 25, 2024 · db74fb9 · db74fb9
1 parent d221d58
commit db74fb9
Show file tree

Hide file tree

Showing 2 changed files with 84 additions and 0 deletions.
diff --git a/api/swagger.json b/api/swagger.json
@@ -1558,6 +1558,48 @@
         }
       }
     },
+    "/syms/rescan": {
+      "post": {
+        "description": "Rescan symbols for a given IPSW.",
+        "produces": [
+          "application/json"
+        ],
+        "tags": [
+          "Syms"
+        ],
+        "summary": "Rescan",
+        "operationId": "postRescan",
+        "parameters": [
+          {
+            "type": "string",
+            "description": "path to IPSW",
+            "name": "path",
+            "in": "query",
+            "required": true
+          },
+          {
+            "type": "string",
+            "description": "path to AEA pem DB JSON file",
+            "name": "pem_db",
+            "in": "query"
+          },
+          {
+            "type": "string",
+            "description": "path to symbolication signatures directory",
+            "name": "sig_dir",
+            "in": "query"
+          }
+        ],
+        "responses": {
+          "200": {
+            "$ref": "#/responses/successResponse"
+          },
+          "500": {
+            "$ref": "#/responses/genericError"
+          }
+        }
+      }
+    },
     "/syms/scan": {
       "post": {
         "description": "Scan symbols for a given IPSW.",

diff --git a/www/static/api/swagger.json b/www/static/api/swagger.json
@@ -1558,6 +1558,48 @@
         }
       }
     },
+    "/syms/rescan": {
+      "post": {
+        "description": "Rescan symbols for a given IPSW.",
+        "produces": [
+          "application/json"
+        ],
+        "tags": [
+          "Syms"
+        ],
+        "summary": "Rescan",
+        "operationId": "postRescan",
+        "parameters": [
+          {
+            "type": "string",
+            "description": "path to IPSW",
+            "name": "path",
+            "in": "query",
+            "required": true
+          },
+          {
+            "type": "string",
+            "description": "path to AEA pem DB JSON file",
+            "name": "pem_db",
+            "in": "query"
+          },
+          {
+            "type": "string",
+            "description": "path to symbolication signatures directory",
+            "name": "sig_dir",
+            "in": "query"
+          }
+        ],
+        "responses": {
+          "200": {
+            "$ref": "#/responses/successResponse"
+          },
+          "500": {
+            "$ref": "#/responses/genericError"
+          }
+        }
+      }
+    },
     "/syms/scan": {
       "post": {
         "description": "Scan symbols for a given IPSW.",