mirror of
https://github.com/projectdiscovery/nuclei.git
synced 2025-12-17 19:55:26 +00:00
Auto Generate Syntax Docs + JSONSchema [Thu Sep 16 17:12:26 UTC 2021] 🤖
This commit is contained in:
GitHub Action
parent
2af11f489d
commit
ba587b14bd
@ -348,7 +348,7 @@ Examples:
|
||||
|
||||
|
||||
```yaml
|
||||
description: Bower is a package manager which stores packages informations in bower.json file
|
||||
description: Bower is a package manager which stores packages information in bower.json file
|
||||
```
|
||||
|
||||
```yaml
|
||||
@ -679,7 +679,7 @@ Matchers contains the detection mechanism for the request to identify
|
||||
whether the request was successful by doing pattern matching
|
||||
on request/responses.
|
||||
|
||||
Multiple matchers can be combined together with `matcher-condition` flag
|
||||
Multiple matchers can be combined with `matcher-condition` flag
|
||||
which accepts either `and` or `or` as argument.
|
||||
|
||||
</div>
|
||||
@ -792,7 +792,7 @@ raw:
|
||||
</div>
|
||||
<div class="dt">
|
||||
|
||||
ID is the the optional id of the request
|
||||
ID is the optional id of the request
|
||||
|
||||
</div>
|
||||
|
||||
@ -1668,7 +1668,7 @@ group: 1
|
||||
description: |
|
||||
kval contains the key-value pairs present in the HTTP response header.
|
||||
kval extractor can be used to extract HTTP response header and cookie key-value pairs.
|
||||
kval extractor inputs are case insensitive, and does not support dash (-) in input which can replaced with underscores (_)
|
||||
kval extractor inputs are case-insensitive, and does not support dash (-) in input which can replaced with underscores (_)
|
||||
For example, Content-Type should be replaced with content_type
|
||||
|
||||
A list of supported parts is available in docs for request types.
|
||||
@ -1846,7 +1846,7 @@ Matchers contains the detection mechanism for the request to identify
|
||||
whether the request was successful by doing pattern matching
|
||||
on request/responses.
|
||||
|
||||
Multiple matchers can be combined together with `matcher-condition` flag
|
||||
Multiple matchers can be combined with `matcher-condition` flag
|
||||
which accepts either `and` or `or` as argument.
|
||||
|
||||
</div>
|
||||
@ -1894,7 +1894,7 @@ Valid values:
|
||||
</div>
|
||||
<div class="dt">
|
||||
|
||||
ID is the the optional id of the request
|
||||
ID is the optional id of the request
|
||||
|
||||
</div>
|
||||
|
||||
@ -2061,7 +2061,7 @@ Matchers contains the detection mechanism for the request to identify
|
||||
whether the request was successful by doing pattern matching
|
||||
on request/responses.
|
||||
|
||||
Multiple matchers can be combined together with `matcher-condition` flag
|
||||
Multiple matchers can be combined with `matcher-condition` flag
|
||||
which accepts either `and` or `or` as argument.
|
||||
|
||||
</div>
|
||||
@ -2164,7 +2164,7 @@ denylist:
|
||||
</div>
|
||||
<div class="dt">
|
||||
|
||||
ID is the the optional id of the request
|
||||
ID is the optional id of the request
|
||||
|
||||
</div>
|
||||
|
||||
@ -2244,7 +2244,7 @@ matchers:
|
||||
</div>
|
||||
<div class="dt">
|
||||
|
||||
ID is the the optional id of the request
|
||||
ID is the optional id of the request
|
||||
|
||||
</div>
|
||||
|
||||
@ -2368,7 +2368,7 @@ Matchers contains the detection mechanism for the request to identify
|
||||
whether the request was successful by doing pattern matching
|
||||
on request/responses.
|
||||
|
||||
Multiple matchers can be combined together with `matcher-condition` flag
|
||||
Multiple matchers can be combined with `matcher-condition` flag
|
||||
which accepts either `and` or `or` as argument.
|
||||
|
||||
</div>
|
||||
@ -2550,7 +2550,7 @@ Appears in:
|
||||
</div>
|
||||
<div class="dt">
|
||||
|
||||
ID is the the optional id of the request
|
||||
ID is the optional id of the request
|
||||
|
||||
</div>
|
||||
|
||||
@ -2580,7 +2580,7 @@ Matchers contains the detection mechanism for the request to identify
|
||||
whether the request was successful by doing pattern matching
|
||||
on request/responses.
|
||||
|
||||
Multiple matchers can be combined together with `matcher-condition` flag
|
||||
Multiple matchers can be combined with `matcher-condition` flag
|
||||
which accepts either `and` or `or` as argument.
|
||||
|
||||
</div>
|
||||
@ -2825,7 +2825,7 @@ Matchers perform name based matching to run subtemplates for a workflow.
|
||||
</div>
|
||||
<div class="dt">
|
||||
|
||||
Subtemplates are ran if the `template` field Template matches.
|
||||
Subtemplates are run if the `template` field Template matches.
|
||||
|
||||
</div>
|
||||
|
||||
@ -2866,7 +2866,7 @@ Name is the name of the item to match.
|
||||
</div>
|
||||
<div class="dt">
|
||||
|
||||
Subtemplates are ran if the name of matcher matches.
|
||||
Subtemplates are run if the name of matcher matches.
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@ -126,7 +126,7 @@ func init() {
|
||||
MODELInfoDoc.Fields[3].Description = "Description of the template.\n\nYou can go in-depth here on what the template actually does."
|
||||
MODELInfoDoc.Fields[3].Comments[encoder.LineComment] = "Description of the template."
|
||||
|
||||
MODELInfoDoc.Fields[3].AddExample("", "Bower is a package manager which stores packages informations in bower.json file")
|
||||
MODELInfoDoc.Fields[3].AddExample("", "Bower is a package manager which stores packages information in bower.json file")
|
||||
|
||||
MODELInfoDoc.Fields[3].AddExample("", "Subversion ALM for the enterprise before 8.8.2 allows reflected XSS at multiple locations")
|
||||
MODELInfoDoc.Fields[4].Name = "reference"
|
||||
@ -274,7 +274,7 @@ func init() {
|
||||
HTTPRequestDoc.Fields[0].Name = "matchers"
|
||||
HTTPRequestDoc.Fields[0].Type = "[]matchers.Matcher"
|
||||
HTTPRequestDoc.Fields[0].Note = ""
|
||||
HTTPRequestDoc.Fields[0].Description = "Matchers contains the detection mechanism for the request to identify\nwhether the request was successful by doing pattern matching\non request/responses.\n\nMultiple matchers can be combined together with `matcher-condition` flag\nwhich accepts either `and` or `or` as argument."
|
||||
HTTPRequestDoc.Fields[0].Description = "Matchers contains the detection mechanism for the request to identify\nwhether the request was successful by doing pattern matching\non request/responses.\n\nMultiple matchers can be combined with `matcher-condition` flag\nwhich accepts either `and` or `or` as argument."
|
||||
HTTPRequestDoc.Fields[0].Comments[encoder.LineComment] = "Matchers contains the detection mechanism for the request to identify"
|
||||
HTTPRequestDoc.Fields[1].Name = "extractors"
|
||||
HTTPRequestDoc.Fields[1].Type = "[]extractors.Extractor"
|
||||
@ -307,8 +307,8 @@ func init() {
|
||||
HTTPRequestDoc.Fields[5].Name = "id"
|
||||
HTTPRequestDoc.Fields[5].Type = "string"
|
||||
HTTPRequestDoc.Fields[5].Note = ""
|
||||
HTTPRequestDoc.Fields[5].Description = "ID is the the optional id of the request"
|
||||
HTTPRequestDoc.Fields[5].Comments[encoder.LineComment] = " ID is the the optional id of the request"
|
||||
HTTPRequestDoc.Fields[5].Description = "ID is the optional id of the request"
|
||||
HTTPRequestDoc.Fields[5].Comments[encoder.LineComment] = " ID is the optional id of the request"
|
||||
HTTPRequestDoc.Fields[6].Name = "name"
|
||||
HTTPRequestDoc.Fields[6].Type = "string"
|
||||
HTTPRequestDoc.Fields[6].Note = ""
|
||||
@ -629,7 +629,7 @@ func init() {
|
||||
EXTRACTORSExtractorDoc.Fields[4].Name = "kval"
|
||||
EXTRACTORSExtractorDoc.Fields[4].Type = "[]string"
|
||||
EXTRACTORSExtractorDoc.Fields[4].Note = ""
|
||||
EXTRACTORSExtractorDoc.Fields[4].Description = "description: |\n kval contains the key-value pairs present in the HTTP response header.\n kval extractor can be used to extract HTTP response header and cookie key-value pairs.\n kval extractor inputs are case insensitive, and does not support dash (-) in input which can replaced with underscores (_)\n For example, Content-Type should be replaced with content_type\n\n A list of supported parts is available in docs for request types.\n examples:\n - name: Extract Server Header From HTTP Response\n value: >\n []string{\"server\"}\n - name: Extracting value of PHPSESSID Cookie\n value: >\n []string{\"phpsessid\"}\n - name: Extracting value of Content-Type Cookie\n value: >\n []string{\"content_type\"}"
|
||||
EXTRACTORSExtractorDoc.Fields[4].Description = "description: |\n kval contains the key-value pairs present in the HTTP response header.\n kval extractor can be used to extract HTTP response header and cookie key-value pairs.\n kval extractor inputs are case-insensitive, and does not support dash (-) in input which can replaced with underscores (_)\n For example, Content-Type should be replaced with content_type\n\n A list of supported parts is available in docs for request types.\n examples:\n - name: Extract Server Header From HTTP Response\n value: >\n []string{\"server\"}\n - name: Extracting value of PHPSESSID Cookie\n value: >\n []string{\"phpsessid\"}\n - name: Extracting value of Content-Type Cookie\n value: >\n []string{\"content_type\"}"
|
||||
EXTRACTORSExtractorDoc.Fields[4].Comments[encoder.LineComment] = " description: |"
|
||||
EXTRACTORSExtractorDoc.Fields[5].Name = "json"
|
||||
EXTRACTORSExtractorDoc.Fields[5].Type = "[]string"
|
||||
@ -684,7 +684,7 @@ func init() {
|
||||
DNSRequestDoc.Fields[0].Name = "matchers"
|
||||
DNSRequestDoc.Fields[0].Type = "[]matchers.Matcher"
|
||||
DNSRequestDoc.Fields[0].Note = ""
|
||||
DNSRequestDoc.Fields[0].Description = "Matchers contains the detection mechanism for the request to identify\nwhether the request was successful by doing pattern matching\non request/responses.\n\nMultiple matchers can be combined together with `matcher-condition` flag\nwhich accepts either `and` or `or` as argument."
|
||||
DNSRequestDoc.Fields[0].Description = "Matchers contains the detection mechanism for the request to identify\nwhether the request was successful by doing pattern matching\non request/responses.\n\nMultiple matchers can be combined with `matcher-condition` flag\nwhich accepts either `and` or `or` as argument."
|
||||
DNSRequestDoc.Fields[0].Comments[encoder.LineComment] = "Matchers contains the detection mechanism for the request to identify"
|
||||
DNSRequestDoc.Fields[1].Name = "extractors"
|
||||
DNSRequestDoc.Fields[1].Type = "[]extractors.Extractor"
|
||||
@ -703,8 +703,8 @@ func init() {
|
||||
DNSRequestDoc.Fields[3].Name = "id"
|
||||
DNSRequestDoc.Fields[3].Type = "string"
|
||||
DNSRequestDoc.Fields[3].Note = ""
|
||||
DNSRequestDoc.Fields[3].Description = "ID is the the optional id of the request"
|
||||
DNSRequestDoc.Fields[3].Comments[encoder.LineComment] = " ID is the the optional id of the request"
|
||||
DNSRequestDoc.Fields[3].Description = "ID is the optional id of the request"
|
||||
DNSRequestDoc.Fields[3].Comments[encoder.LineComment] = " ID is the optional id of the request"
|
||||
DNSRequestDoc.Fields[4].Name = "name"
|
||||
DNSRequestDoc.Fields[4].Type = "string"
|
||||
DNSRequestDoc.Fields[4].Note = ""
|
||||
@ -769,7 +769,7 @@ func init() {
|
||||
FILERequestDoc.Fields[0].Name = "matchers"
|
||||
FILERequestDoc.Fields[0].Type = "[]matchers.Matcher"
|
||||
FILERequestDoc.Fields[0].Note = ""
|
||||
FILERequestDoc.Fields[0].Description = "Matchers contains the detection mechanism for the request to identify\nwhether the request was successful by doing pattern matching\non request/responses.\n\nMultiple matchers can be combined together with `matcher-condition` flag\nwhich accepts either `and` or `or` as argument."
|
||||
FILERequestDoc.Fields[0].Description = "Matchers contains the detection mechanism for the request to identify\nwhether the request was successful by doing pattern matching\non request/responses.\n\nMultiple matchers can be combined with `matcher-condition` flag\nwhich accepts either `and` or `or` as argument."
|
||||
FILERequestDoc.Fields[0].Comments[encoder.LineComment] = "Matchers contains the detection mechanism for the request to identify"
|
||||
FILERequestDoc.Fields[1].Name = "extractors"
|
||||
FILERequestDoc.Fields[1].Type = "[]extractors.Extractor"
|
||||
@ -802,8 +802,8 @@ func init() {
|
||||
FILERequestDoc.Fields[5].Name = "id"
|
||||
FILERequestDoc.Fields[5].Type = "string"
|
||||
FILERequestDoc.Fields[5].Note = ""
|
||||
FILERequestDoc.Fields[5].Description = "ID is the the optional id of the request"
|
||||
FILERequestDoc.Fields[5].Comments[encoder.LineComment] = " ID is the 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[6].Name = "max-size"
|
||||
FILERequestDoc.Fields[6].Type = "int"
|
||||
FILERequestDoc.Fields[6].Note = ""
|
||||
@ -832,8 +832,8 @@ func init() {
|
||||
NETWORKRequestDoc.Fields[0].Name = "id"
|
||||
NETWORKRequestDoc.Fields[0].Type = "string"
|
||||
NETWORKRequestDoc.Fields[0].Note = ""
|
||||
NETWORKRequestDoc.Fields[0].Description = "ID is the the optional id of the request"
|
||||
NETWORKRequestDoc.Fields[0].Comments[encoder.LineComment] = " ID is the the optional id of the request"
|
||||
NETWORKRequestDoc.Fields[0].Description = "ID is the optional id of the request"
|
||||
NETWORKRequestDoc.Fields[0].Comments[encoder.LineComment] = " ID is the optional id of the request"
|
||||
NETWORKRequestDoc.Fields[1].Name = "host"
|
||||
NETWORKRequestDoc.Fields[1].Type = "[]string"
|
||||
NETWORKRequestDoc.Fields[1].Note = ""
|
||||
@ -871,7 +871,7 @@ func init() {
|
||||
NETWORKRequestDoc.Fields[6].Name = "matchers"
|
||||
NETWORKRequestDoc.Fields[6].Type = "[]matchers.Matcher"
|
||||
NETWORKRequestDoc.Fields[6].Note = ""
|
||||
NETWORKRequestDoc.Fields[6].Description = "Matchers contains the detection mechanism for the request to identify\nwhether the request was successful by doing pattern matching\non request/responses.\n\nMultiple matchers can be combined together with `matcher-condition` flag\nwhich accepts either `and` or `or` as argument."
|
||||
NETWORKRequestDoc.Fields[6].Description = "Matchers contains the detection mechanism for the request to identify\nwhether the request was successful by doing pattern matching\non request/responses.\n\nMultiple matchers can be combined with `matcher-condition` flag\nwhich accepts either `and` or `or` as argument."
|
||||
NETWORKRequestDoc.Fields[6].Comments[encoder.LineComment] = "Matchers contains the detection mechanism for the request to identify"
|
||||
NETWORKRequestDoc.Fields[7].Name = "extractors"
|
||||
NETWORKRequestDoc.Fields[7].Type = "[]extractors.Extractor"
|
||||
@ -944,8 +944,8 @@ func init() {
|
||||
HEADLESSRequestDoc.Fields[0].Name = "id"
|
||||
HEADLESSRequestDoc.Fields[0].Type = "string"
|
||||
HEADLESSRequestDoc.Fields[0].Note = ""
|
||||
HEADLESSRequestDoc.Fields[0].Description = "ID is the the optional id of the request"
|
||||
HEADLESSRequestDoc.Fields[0].Comments[encoder.LineComment] = " ID is the the optional id of the request"
|
||||
HEADLESSRequestDoc.Fields[0].Description = "ID is the optional id of the request"
|
||||
HEADLESSRequestDoc.Fields[0].Comments[encoder.LineComment] = " ID is the optional id of the request"
|
||||
HEADLESSRequestDoc.Fields[1].Name = "steps"
|
||||
HEADLESSRequestDoc.Fields[1].Type = "[]engine.Action"
|
||||
HEADLESSRequestDoc.Fields[1].Note = ""
|
||||
@ -954,7 +954,7 @@ func init() {
|
||||
HEADLESSRequestDoc.Fields[2].Name = "matchers"
|
||||
HEADLESSRequestDoc.Fields[2].Type = "[]matchers.Matcher"
|
||||
HEADLESSRequestDoc.Fields[2].Note = ""
|
||||
HEADLESSRequestDoc.Fields[2].Description = "Matchers contains the detection mechanism for the request to identify\nwhether the request was successful by doing pattern matching\non request/responses.\n\nMultiple matchers can be combined together with `matcher-condition` flag\nwhich accepts either `and` or `or` as argument."
|
||||
HEADLESSRequestDoc.Fields[2].Description = "Matchers contains the detection mechanism for the request to identify\nwhether the request was successful by doing pattern matching\non request/responses.\n\nMultiple matchers can be combined with `matcher-condition` flag\nwhich accepts either `and` or `or` as argument."
|
||||
HEADLESSRequestDoc.Fields[2].Comments[encoder.LineComment] = "Matchers contains the detection mechanism for the request to identify"
|
||||
HEADLESSRequestDoc.Fields[3].Name = "extractors"
|
||||
HEADLESSRequestDoc.Fields[3].Type = "[]extractors.Extractor"
|
||||
@ -1065,8 +1065,8 @@ func init() {
|
||||
WORKFLOWSWorkflowTemplateDoc.Fields[3].Name = "subtemplates"
|
||||
WORKFLOWSWorkflowTemplateDoc.Fields[3].Type = "[]workflows.WorkflowTemplate"
|
||||
WORKFLOWSWorkflowTemplateDoc.Fields[3].Note = ""
|
||||
WORKFLOWSWorkflowTemplateDoc.Fields[3].Description = "Subtemplates are ran if the `template` field Template matches."
|
||||
WORKFLOWSWorkflowTemplateDoc.Fields[3].Comments[encoder.LineComment] = "Subtemplates are ran if the `template` field Template matches."
|
||||
WORKFLOWSWorkflowTemplateDoc.Fields[3].Description = "Subtemplates are run if the `template` field Template matches."
|
||||
WORKFLOWSWorkflowTemplateDoc.Fields[3].Comments[encoder.LineComment] = "Subtemplates are run if the `template` field Template matches."
|
||||
|
||||
WORKFLOWSMatcherDoc.Type = "workflows.Matcher"
|
||||
WORKFLOWSMatcherDoc.Comments[encoder.LineComment] = ""
|
||||
@ -1086,8 +1086,8 @@ func init() {
|
||||
WORKFLOWSMatcherDoc.Fields[1].Name = "subtemplates"
|
||||
WORKFLOWSMatcherDoc.Fields[1].Type = "[]workflows.WorkflowTemplate"
|
||||
WORKFLOWSMatcherDoc.Fields[1].Note = ""
|
||||
WORKFLOWSMatcherDoc.Fields[1].Description = "Subtemplates are ran if the name of matcher matches."
|
||||
WORKFLOWSMatcherDoc.Fields[1].Comments[encoder.LineComment] = "Subtemplates are ran if the name of matcher matches."
|
||||
WORKFLOWSMatcherDoc.Fields[1].Description = "Subtemplates are run if the name of matcher matches."
|
||||
WORKFLOWSMatcherDoc.Fields[1].Comments[encoder.LineComment] = "Subtemplates are run if the name of matcher matches."
|
||||
}
|
||||
|
||||
// GetTemplateDoc returns documentation for the file templates_doc.go.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user