Auto Generate Syntax Docs + JSONSchema [Mon May 15 13:47:53 UTC 2023] 🤖

SYNTAX-REFERENCE.md

@@ -184,8 +184,6 @@ file:
             - amzn\.mws\.[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
     extensions:
         - all
-    archive: false
-    mimetype: false
 ```
 
 
@@ -2092,8 +2090,6 @@ extractors:
         - amzn\.mws\.[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
 extensions:
     - all
-archive: false
-mimetype: false
 ```
 
 Part Definitions: 
@@ -2200,6 +2196,32 @@ max-size: 5Mb
 ```
 
 
+</div>
+
+<hr />
+
+<div class="dd">
+
+<code>archive</code>  <i>bool</i>
+
+</div>
+<div class="dt">
+
+elaborates archives
+
+</div>
+
+<hr />
+
+<div class="dd">
+
+<code>mime-type</code>  <i>bool</i>
+
+</div>
+<div class="dt">
+
+enables mime types check
+
 </div>
 
 <hr />

nuclei-jsonschema.json

@@ -383,9 +383,10 @@
       "description": "Type of the attack"
     },
     "variables.Variable": {
-      "properties": {},
+      "additionalProperties": true,
-      "additionalProperties": false,
+      "type": "object",
-      "type": "object"
+      "title": "variables for the request",
+      "description": "Additional variables for the request"
     },
     "dns.DNSRequestTypeHolder": {
       "enum": [
@@ -510,10 +511,6 @@
       "type": "object"
     },
     "file.Request": {
-      "required": [
-        "Archive",
-        "MimeType"
-      ],
       "properties": {
         "matchers": {
           "items": {
@@ -566,11 +563,15 @@
           "title": "max size data to run request on",
           "description": "Maximum size of the file to run request on"
         },
-        "Archive": {
+        "archive": {
-          "type": "boolean"
+          "type": "boolean",
+          "title": "enable archives",
+          "description": "Process compressed archives without unpacking"
         },
-        "MimeType": {
+        "mime-type": {
-          "type": "boolean"
+          "type": "boolean",
+          "title": "enable filtering by mime-type",
+          "description": "Filter files by mime-type"
         },
         "no-recursive": {
           "type": "boolean",

v2/pkg/templates/templates_doc.go

@@ -953,7 +953,7 @@ func init() {
 			Value: "Raw contains the raw file contents",
 		},
 	}
-	FILERequestDoc.Fields = make([]encoder.Doc, 5)
+	FILERequestDoc.Fields = make([]encoder.Doc, 7)
 	FILERequestDoc.Fields[0].Name = "extensions"
 	FILERequestDoc.Fields[0].Type = "[]string"
 	FILERequestDoc.Fields[0].Note = ""
@@ -980,11 +980,21 @@ func init() {
 	FILERequestDoc.Fields[3].Comments[encoder.LineComment] = "MaxSize is the maximum size of the file to run request on."
 
 	FILERequestDoc.Fields[3].AddExample("", "5Mb")
-	FILERequestDoc.Fields[4].Name = "no-recursive"
+	FILERequestDoc.Fields[4].Name = "archive"
 	FILERequestDoc.Fields[4].Type = "bool"
 	FILERequestDoc.Fields[4].Note = ""
-	FILERequestDoc.Fields[4].Description = "NoRecursive specifies whether to not do recursive checks if folders are provided."
+	FILERequestDoc.Fields[4].Description = "elaborates archives"
-	FILERequestDoc.Fields[4].Comments[encoder.LineComment] = "NoRecursive specifies whether to not do recursive checks if folders are provided."
+	FILERequestDoc.Fields[4].Comments[encoder.LineComment] = "elaborates archives"
+	FILERequestDoc.Fields[5].Name = "mime-type"
+	FILERequestDoc.Fields[5].Type = "bool"
+	FILERequestDoc.Fields[5].Note = ""
+	FILERequestDoc.Fields[5].Description = "enables mime types check"
+	FILERequestDoc.Fields[5].Comments[encoder.LineComment] = "enables mime types check"
+	FILERequestDoc.Fields[6].Name = "no-recursive"
+	FILERequestDoc.Fields[6].Type = "bool"
+	FILERequestDoc.Fields[6].Note = ""
+	FILERequestDoc.Fields[6].Description = "NoRecursive specifies whether to not do recursive checks if folders are provided."
+	FILERequestDoc.Fields[6].Comments[encoder.LineComment] = "NoRecursive specifies whether to not do recursive checks if folders are provided."
 
 	NETWORKRequestDoc.Type = "network.Request"
 	NETWORKRequestDoc.Comments[encoder.LineComment] = " Request contains a Network protocol request to be made from a template"