Auto Generate Syntax Docs + JSONSchema [Mon Mar 21 10:22:10 UTC 2022] 🤖

dev
GitHub Action 2022-03-21 10:22:10 +00:00
parent d1f6fd9115
commit f4e6e892e0
3 changed files with 16 additions and 7 deletions

View File

@ -166,6 +166,7 @@ file:
- amzn\.mws\.[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12} - amzn\.mws\.[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
extensions: extensions:
- all - all
archive: false
``` ```
@ -2570,6 +2571,7 @@ extractors:
- amzn\.mws\.[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12} - amzn\.mws\.[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
extensions: extensions:
- all - all
archive: false
``` ```
Part Definitions: Part Definitions:
@ -2707,15 +2709,16 @@ ID is the optional id of the request
<div class="dd"> <div class="dd">
<code>max-size</code> <i>int</i> <code>max-size</code> <i>string</i>
</div> </div>
<div class="dt"> <div class="dt">
MaxSize is the maximum size of the file to run request on. MaxSize is the maximum size of the file to run request on.
By default, nuclei will process 5 MB files and not go more than that. By default, nuclei will process 1 GB of content and not go more than that.
It can be set to much lower or higher depending on use. It can be set to much lower or higher depending on use.
If set to "no" then all content will be processed
@ -2723,7 +2726,7 @@ Examples:
```yaml ```yaml
max-size: 2048 max-size: 5Mb
``` ```

View File

@ -450,6 +450,9 @@
"type": "object" "type": "object"
}, },
"file.Request": { "file.Request": {
"required": [
"Archive"
],
"properties": { "properties": {
"matchers": { "matchers": {
"items": { "items": {
@ -498,10 +501,13 @@
"description": "ID is the optional ID for the request" "description": "ID is the optional ID for the request"
}, },
"max-size": { "max-size": {
"type": "integer", "type": "string",
"title": "max size data to run request on", "title": "max size data to run request on",
"description": "Maximum size of the file to run request on" "description": "Maximum size of the file to run request on"
}, },
"Archive": {
"type": "boolean"
},
"no-recursive": { "no-recursive": {
"type": "boolean", "type": "boolean",
"title": "do not perform recursion", "title": "do not perform recursion",

View File

@ -1214,12 +1214,12 @@ func init() {
FILERequestDoc.Fields[5].Description = "ID is the optional id of the request" FILERequestDoc.Fields[5].Description = "ID is the optional id of the request"
FILERequestDoc.Fields[5].Comments[encoder.LineComment] = " ID is the optional id of the request" FILERequestDoc.Fields[5].Comments[encoder.LineComment] = " ID is the optional id of the request"
FILERequestDoc.Fields[6].Name = "max-size" FILERequestDoc.Fields[6].Name = "max-size"
FILERequestDoc.Fields[6].Type = "int" FILERequestDoc.Fields[6].Type = "string"
FILERequestDoc.Fields[6].Note = "" FILERequestDoc.Fields[6].Note = ""
FILERequestDoc.Fields[6].Description = "MaxSize is the maximum size of the file to run request on.\n\nBy default, nuclei will process 5 MB files and not go more than that.\nIt can be set to much lower or higher depending on use." FILERequestDoc.Fields[6].Description = "MaxSize is the maximum size of the file to run request on.\n\nBy default, nuclei will process 1 GB of content and not go more than that.\nIt can be set to much lower or higher depending on use.\nIf set to \"no\" then all content will be processed"
FILERequestDoc.Fields[6].Comments[encoder.LineComment] = "MaxSize is the maximum size of the file to run request on." FILERequestDoc.Fields[6].Comments[encoder.LineComment] = "MaxSize is the maximum size of the file to run request on."
FILERequestDoc.Fields[6].AddExample("", 2048) FILERequestDoc.Fields[6].AddExample("", "5Mb")
FILERequestDoc.Fields[7].Name = "no-recursive" FILERequestDoc.Fields[7].Name = "no-recursive"
FILERequestDoc.Fields[7].Type = "bool" FILERequestDoc.Fields[7].Type = "bool"
FILERequestDoc.Fields[7].Note = "" FILERequestDoc.Fields[7].Note = ""