Auto Generate Syntax Docs + JSONSchema [Mon Nov 29 06:49:56 UTC 2021] 🤖

This commit is contained in:
GitHub Action 2021-11-29 06:49:56 +00:00
parent 95f31090dc
commit 345a5a3de5
2 changed files with 9 additions and 9 deletions

View File

@ -847,7 +847,7 @@ ID is the optional id of the request
Name is the optional name of the request. Name is the optional name of the request.
If a name is specified, all the named request in a template can be matched upon If a name is specified, all the named request in a template can be matched upon
in a combined manner allowing multirequest based matchers. in a combined manner allowing multi-request based matchers.
</div> </div>
@ -862,7 +862,7 @@ in a combined manner allowing multirequest based matchers.
Attack is the type of payload combinations to perform. Attack is the type of payload combinations to perform.
batteringram is same payload into all of the defined payload positions at once, pitchfork combines multiple payload sets and clusterbomb generates batteringram is inserts the same payload into all defined payload positions at once, pitchfork combines multiple payload sets and clusterbomb generates
permutations and combinations for all payloads. permutations and combinations for all payloads.
@ -1454,7 +1454,7 @@ Examples:
```yaml ```yaml
# Match for outlook mail protection domain # Match for Outlook mail protection domain
words: words:
- mail.protection.outlook.com - mail.protection.outlook.com
``` ```
@ -2452,7 +2452,7 @@ host:
Attack is the type of payload combinations to perform. Attack is the type of payload combinations to perform.
Batteringram is same payload into all of the defined payload positions at once, pitchfork combines multiple payload sets and clusterbomb generates Batteringram is inserts the same payload into all defined payload positions at once, pitchfork combines multiple payload sets and clusterbomb generates
permutations and combinations for all payloads. permutations and combinations for all payloads.
@ -2676,7 +2676,7 @@ Valid values:
Read is the number of bytes to read from socket. Read is the number of bytes to read from socket.
This can be used for protocols which expect an immediate response. You can This can be used for protocols which expect an immediate response. You can
read and write responses one after another and evetually perform matching read and write responses one after another and eventually perform matching
on every data captured with `name` attribute. on every data captured with `name` attribute.
The [network docs](https://nuclei.projectdiscovery.io/templating-guide/protocols/network/) highlight more on how to do this. The [network docs](https://nuclei.projectdiscovery.io/templating-guide/protocols/network/) highlight more on how to do this.

View File

@ -336,7 +336,7 @@ func init() {
HTTPRequestDoc.Fields[7].Name = "attack" HTTPRequestDoc.Fields[7].Name = "attack"
HTTPRequestDoc.Fields[7].Type = "generators.AttackTypeHolder" HTTPRequestDoc.Fields[7].Type = "generators.AttackTypeHolder"
HTTPRequestDoc.Fields[7].Note = "" HTTPRequestDoc.Fields[7].Note = ""
HTTPRequestDoc.Fields[7].Description = "Attack is the type of payload combinations to perform.\n\nbatteringram is same payload into all of the defined payload positions at once, pitchfork combines multiple payload sets and clusterbomb generates\npermutations and combinations for all payloads." HTTPRequestDoc.Fields[7].Description = "Attack is the type of payload combinations to perform.\n\nbatteringram is inserts the same payload into all defined payload positions at once, pitchfork combines multiple payload sets and clusterbomb generates\npermutations and combinations for all payloads."
HTTPRequestDoc.Fields[7].Comments[encoder.LineComment] = "Attack is the type of payload combinations to perform." HTTPRequestDoc.Fields[7].Comments[encoder.LineComment] = "Attack is the type of payload combinations to perform."
HTTPRequestDoc.Fields[7].Values = []string{ HTTPRequestDoc.Fields[7].Values = []string{
"batteringram", "batteringram",
@ -559,7 +559,7 @@ func init() {
MATCHERSMatcherDoc.Fields[7].Description = "Words contains word patterns required to be present in the response part." MATCHERSMatcherDoc.Fields[7].Description = "Words contains word patterns required to be present in the response part."
MATCHERSMatcherDoc.Fields[7].Comments[encoder.LineComment] = "Words contains word patterns required to be present in the response part." MATCHERSMatcherDoc.Fields[7].Comments[encoder.LineComment] = "Words contains word patterns required to be present in the response part."
MATCHERSMatcherDoc.Fields[7].AddExample("Match for outlook mail protection domain", []string{"mail.protection.outlook.com"}) MATCHERSMatcherDoc.Fields[7].AddExample("Match for Outlook mail protection domain", []string{"mail.protection.outlook.com"})
MATCHERSMatcherDoc.Fields[7].AddExample("Match for application/json in response headers", []string{"application/json"}) MATCHERSMatcherDoc.Fields[7].AddExample("Match for application/json in response headers", []string{"application/json"})
MATCHERSMatcherDoc.Fields[8].Name = "regex" MATCHERSMatcherDoc.Fields[8].Name = "regex"
@ -938,7 +938,7 @@ func init() {
NETWORKRequestDoc.Fields[2].Name = "attack" NETWORKRequestDoc.Fields[2].Name = "attack"
NETWORKRequestDoc.Fields[2].Type = "generators.AttackTypeHolder" NETWORKRequestDoc.Fields[2].Type = "generators.AttackTypeHolder"
NETWORKRequestDoc.Fields[2].Note = "" NETWORKRequestDoc.Fields[2].Note = ""
NETWORKRequestDoc.Fields[2].Description = "Attack is the type of payload combinations to perform.\n\nBatteringram is same payload into all of the defined payload positions at once, pitchfork combines multiple payload sets and clusterbomb generates\npermutations and combinations for all payloads." NETWORKRequestDoc.Fields[2].Description = "Attack is the type of payload combinations to perform.\n\nBatteringram is inserts the same payload into all defined payload positions at once, pitchfork combines multiple payload sets and clusterbomb generates\npermutations and combinations for all payloads."
NETWORKRequestDoc.Fields[2].Comments[encoder.LineComment] = "Attack is the type of payload combinations to perform." NETWORKRequestDoc.Fields[2].Comments[encoder.LineComment] = "Attack is the type of payload combinations to perform."
NETWORKRequestDoc.Fields[2].Values = []string{ NETWORKRequestDoc.Fields[2].Values = []string{
"batteringram", "batteringram",
@ -1020,7 +1020,7 @@ func init() {
NETWORKInputDoc.Fields[2].Name = "read" NETWORKInputDoc.Fields[2].Name = "read"
NETWORKInputDoc.Fields[2].Type = "int" NETWORKInputDoc.Fields[2].Type = "int"
NETWORKInputDoc.Fields[2].Note = "" NETWORKInputDoc.Fields[2].Note = ""
NETWORKInputDoc.Fields[2].Description = "Read is the number of bytes to read from socket.\n\nThis can be used for protocols which expect an immediate response. You can\nread and write responses one after another and evetually perform matching\non every data captured with `name` attribute.\n\nThe [network docs](https://nuclei.projectdiscovery.io/templating-guide/protocols/network/) highlight more on how to do this." NETWORKInputDoc.Fields[2].Description = "Read is the number of bytes to read from socket.\n\nThis can be used for protocols which expect an immediate response. You can\nread and write responses one after another and eventually perform matching\non every data captured with `name` attribute.\n\nThe [network docs](https://nuclei.projectdiscovery.io/templating-guide/protocols/network/) highlight more on how to do this."
NETWORKInputDoc.Fields[2].Comments[encoder.LineComment] = "Read is the number of bytes to read from socket." NETWORKInputDoc.Fields[2].Comments[encoder.LineComment] = "Read is the number of bytes to read from socket."
NETWORKInputDoc.Fields[2].AddExample("", 1024) NETWORKInputDoc.Fields[2].AddExample("", 1024)