Skip to content

Commit

Permalink
auto gen docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
ehsandeep committed Nov 21, 2024
1 parent 2b4b058 commit a09fcc1
Show file tree
Hide file tree
Showing 3 changed files with 192 additions and 74 deletions.
66 changes: 66 additions & 0 deletions SYNTAX-REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -1373,6 +1373,19 @@ Fuzzing describes schema to fuzz http requests
<div class="dd">
<code>analyzer</code> <i><a href="#analyzersanalyzertemplate">analyzers.AnalyzerTemplate</a></i>
</div>
<div class="dt">
Analyzer is an analyzer to use for matching the response.
</div>
<hr />
<div class="dd">
<code>self-contained</code> <i>bool</i>
</div>
Expand Down Expand Up @@ -2025,6 +2038,59 @@ Appears in:



## analyzers.AnalyzerTemplate
AnalyzerTemplate is the template for the analyzer

Appears in:


- <code><a href="#httprequest">http.Request</a>.analyzer</code>





<hr />

<div class="dd">

<code>name</code> <i>string</i>

</div>
<div class="dt">

Name is the name of the analyzer to use


Valid values:


- <code>time_delay</code>
</div>

<hr />

<div class="dd">

<code>parameters</code> <i>map[string]interface{}</i>

</div>
<div class="dt">

Parameters is the parameters for the analyzer

Parameters are different for each analyzer. For example, you can customize
time_delay analyzer with sleep_duration, time_slope_error_range, etc. Refer
to the docs for each analyzer to get an idea about parameters.

</div>

<hr />





## SignatureTypeHolder
SignatureTypeHolder is used to hold internal type of the signature

Expand Down
21 changes: 21 additions & 0 deletions nuclei-jsonschema.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,22 @@
"$id": "https://templates.-template",
"$ref": "#/$defs/templates.Template",
"$defs": {
"analyzers.AnalyzerTemplate": {
"properties": {
"name": {
"type": "string"
},
"parameters": {
"$ref": "#/$defs/map[string]interface {}"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"parameters"
]
},
"code.Request": {
"properties": {
"matchers": {
Expand Down Expand Up @@ -785,6 +801,11 @@
"title": "fuzzin rules for http fuzzing",
"description": "Fuzzing describes rule schema to fuzz http requests"
},
"analyzer": {
"$ref": "#/$defs/analyzers.AnalyzerTemplate",
"title": "analyzer for http request",
"description": "Analyzer for HTTP Request"
},
"self-contained": {
"type": "boolean"
},
Expand Down
Loading

0 comments on commit a09fcc1

Please sign in to comment.