(chore/api) update api documentation

sensepost · Oct 10, 2024 · 5b11e4c · 5b11e4c
1 parent dad7d64
commit 5b11e4c
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 3 deletions.
diff --git a/web/docs/docs.go b/web/docs/docs.go
@@ -226,7 +226,7 @@ const docTemplate = `{
                 "summary": "Search for results",
                 "parameters": [
                     {
-                        "description": "The search term to search for. Supports search operators: ` + "`" + `title:` + "`" + `, ` + "`" + `tech:` + "`" + `, ` + "`" + `header:` + "`" + `",
+                        "description": "The search term to search for. Supports search operators: ` + "`" + `title:` + "`" + `, ` + "`" + `tech:` + "`" + `, ` + "`" + `header:` + "`" + `, ` + "`" + `body:` + "`" + `, ` + "`" + `p:` + "`" + `",
                         "name": "query",
                         "in": "body",
                         "required": true,
@@ -390,6 +390,9 @@ const docTemplate = `{
                 "response_code": {
                     "type": "integer"
                 },
+                "screenshot": {
+                    "type": "string"
+                },
                 "technologies": {
                     "type": "array",
                     "items": {
@@ -504,6 +507,9 @@ const docTemplate = `{
                 "response_reason": {
                     "type": "string"
                 },
+                "screenshot": {
+                    "type": "string"
+                },
                 "title": {
                     "type": "string"
                 },

diff --git a/web/docs/swagger.json b/web/docs/swagger.json
@@ -215,7 +215,7 @@
                 "summary": "Search for results",
                 "parameters": [
                     {
-                        "description": "The search term to search for. Supports search operators: `title:`, `tech:`, `header:`",
+                        "description": "The search term to search for. Supports search operators: `title:`, `tech:`, `header:`, `body:`, `p:`",
                         "name": "query",
                         "in": "body",
                         "required": true,
@@ -379,6 +379,9 @@
                 "response_code": {
                     "type": "integer"
                 },
+                "screenshot": {
+                    "type": "string"
+                },
                 "technologies": {
                     "type": "array",
                     "items": {
@@ -493,6 +496,9 @@
                 "response_reason": {
                     "type": "string"
                 },
+                "screenshot": {
+                    "type": "string"
+                },
                 "title": {
                     "type": "string"
                 },

diff --git a/web/docs/swagger.yaml b/web/docs/swagger.yaml
@@ -16,6 +16,8 @@ definitions:
         type: string
       response_code:
         type: integer
+      screenshot:
+        type: string
       technologies:
         items:
           type: string
@@ -91,6 +93,8 @@ definitions:
         type: integer
       response_reason:
         type: string
+      screenshot:
+        type: string
       title:
         type: string
       url:
@@ -491,7 +495,7 @@ paths:
       description: Searches for results based on free form text, or operators.
       parameters:
       - description: 'The search term to search for. Supports search operators: `title:`,
-          `tech:`, `header:`'
+          `tech:`, `header:`, `body:`, `p:`'
         in: body
         name: query
         required: true