Auto Generate Syntax Docs + JSONSchema [Tue Mar 29 12:22:43 UTC 2022] 🤖

dev
GitHub Action 2022-03-29 12:22:43 +00:00
parent e8690f378d
commit 924b615a6c
3 changed files with 13 additions and 7 deletions

View File

@ -167,6 +167,7 @@ file:
extensions:
- all
archive: false
mimetype: false
```
@ -2572,6 +2573,7 @@ extractors:
extensions:
- all
archive: false
mimetype: false
```
Part Definitions:
@ -2646,7 +2648,7 @@ Valid values:
</div>
<div class="dt">
Extensions is the list of extensions to perform matching on.
Extensions is the list of extensions or mime types to perform matching on.
@ -2672,7 +2674,7 @@ extensions:
</div>
<div class="dt">
DenyList is the list of file, directories or extensions to deny during matching.
DenyList is the list of file, directories, mime types or extensions to deny during matching.
By default, it contains some non-interesting extensions that are hardcoded
in nuclei.

View File

@ -451,7 +451,8 @@
},
"file.Request": {
"required": [
"Archive"
"Archive",
"MimeType"
],
"properties": {
"matchers": {
@ -508,6 +509,9 @@
"Archive": {
"type": "boolean"
},
"MimeType": {
"type": "boolean"
},
"no-recursive": {
"type": "boolean",
"title": "do not perform recursion",

View File

@ -1197,15 +1197,15 @@ func init() {
FILERequestDoc.Fields[3].Name = "extensions"
FILERequestDoc.Fields[3].Type = "[]string"
FILERequestDoc.Fields[3].Note = ""
FILERequestDoc.Fields[3].Description = "Extensions is the list of extensions to perform matching on."
FILERequestDoc.Fields[3].Comments[encoder.LineComment] = "Extensions is the list of extensions to perform matching on."
FILERequestDoc.Fields[3].Description = "Extensions is the list of extensions or mime types to perform matching on."
FILERequestDoc.Fields[3].Comments[encoder.LineComment] = "Extensions is the list of extensions or mime types to perform matching on."
FILERequestDoc.Fields[3].AddExample("", []string{".txt", ".go", ".json"})
FILERequestDoc.Fields[4].Name = "denylist"
FILERequestDoc.Fields[4].Type = "[]string"
FILERequestDoc.Fields[4].Note = ""
FILERequestDoc.Fields[4].Description = "DenyList is the list of file, directories or extensions to deny during matching.\n\nBy default, it contains some non-interesting extensions that are hardcoded\nin nuclei."
FILERequestDoc.Fields[4].Comments[encoder.LineComment] = "DenyList is the list of file, directories or extensions to deny during matching."
FILERequestDoc.Fields[4].Description = "DenyList is the list of file, directories, mime types or extensions to deny during matching.\n\nBy default, it contains some non-interesting extensions that are hardcoded\nin nuclei."
FILERequestDoc.Fields[4].Comments[encoder.LineComment] = "DenyList is the list of file, directories, mime types or extensions to deny during matching."
FILERequestDoc.Fields[4].AddExample("", []string{".avi", ".mov", ".mp3"})
FILERequestDoc.Fields[5].Name = "id"