External/nuclei
1
0
Fork 0
mirror of https://github.com/projectdiscovery/nuclei.git synced 2025-12-18 04:45:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix publish docs (#3296)

Browse Source 
* add branch ref while checkout

* Auto Generate Syntax Docs + JSONSchema [Thu Feb  9 13:36:50 UTC 2023] 🤖

---------

Co-authored-by: GitHub Action <action@github.com>
This commit is contained in:
Tarun Koyalwar 2023-02-09 19:14:43 +05:30 committed by GitHub
parent 7556416e5b
commit a62e57f6c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 41 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/publish-docs.yaml vendored
View File

@ -14,6 +14,7 @@ jobs:
uses: actions/checkout@v3
with:
fetch-depth: 0
ref: ${{ github.head_ref }}
- name: "Set up Go"
uses: actions/setup-go@v3

17
SYNTAX-REFERENCE.md
View File

@ -132,7 +132,6 @@ dns:
regex:
- ec2-[-\d]+\.compute[-\d]*\.amazonaws\.com
- ec2-[-\d]+\.[\w\d\-]+\.compute[-\d]*\.amazonaws\.com
dsl: []
name: '{{FQDN}}'
type: CNAME
class: inet
@ -165,7 +164,6 @@ file:
- type: regex
regex:
- amzn\.mws\.[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
dsl: []
extensions:
- all
archive: false
@ -2077,6 +2075,19 @@ attribute: href
```
</div>
<hr />
<div class="dd">
<code>dsl</code> <i>[]string</i>
</div>
<div class="dt">
Extracts using DSL expressions.
</div>
<hr />
@ -2515,7 +2526,6 @@ extractors:
regex:
- ec2-[-\d]+\.compute[-\d]*\.amazonaws\.com
- ec2-[-\d]+\.[\w\d\-]+\.compute[-\d]*\.amazonaws\.com
dsl: []
name: '{{FQDN}}'
type: CNAME
class: inet
@ -2837,7 +2847,6 @@ extractors:
- type: regex
regex:
- amzn\.mws\.[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
dsl: []
extensions:
- all
archive: false

9
nuclei-jsonschema.json
View File

@ -132,8 +132,7 @@
},
"extractors.Extractor": {
"required": [
"type",
"DSL"
"type"
],
"properties": {
"name": {
@ -187,11 +186,13 @@
"title": "optional attribute to extract from xpath",
"description": "Optional attribute to extract from response XPath"
},
"DSL": {
"dsl": {
"items": {
"type": "string"
},
"type": "array"
"type": "array",
"title": "dsl expressions to extract",
"description": "Optional attribute to extract from response dsl"
},
"part": {
"type": "string",

39
v2/pkg/templates/templates_doc.go
View File

@ -811,7 +811,7 @@ func init() {
FieldName: "extractors",
},
}
EXTRACTORSExtractorDoc.Fields = make([]encoder.Doc, 11)
EXTRACTORSExtractorDoc.Fields = make([]encoder.Doc, 12)
EXTRACTORSExtractorDoc.Fields[0].Name = "name"
EXTRACTORSExtractorDoc.Fields[0].Type = "string"
EXTRACTORSExtractorDoc.Fields[0].Note = ""
@ -868,26 +868,31 @@ func init() {
EXTRACTORSExtractorDoc.Fields[7].Comments[encoder.LineComment] = "Attribute is an optional attribute to extract from response XPath."
EXTRACTORSExtractorDoc.Fields[7].AddExample("", "href")
EXTRACTORSExtractorDoc.Fields[8].Name = "part"
EXTRACTORSExtractorDoc.Fields[8].Type = "string"
EXTRACTORSExtractorDoc.Fields[8].Name = "dsl"
EXTRACTORSExtractorDoc.Fields[8].Type = "[]string"
EXTRACTORSExtractorDoc.Fields[8].Note = ""
EXTRACTORSExtractorDoc.Fields[8].Description = "Part is the part of the request response to extract data from.\n\nEach protocol exposes a lot of different parts which are well\ndocumented in docs for each request type."
EXTRACTORSExtractorDoc.Fields[8].Comments[encoder.LineComment] = "Part is the part of the request response to extract data from."
EXTRACTORSExtractorDoc.Fields[8].AddExample("", "body")
EXTRACTORSExtractorDoc.Fields[8].AddExample("", "raw")
EXTRACTORSExtractorDoc.Fields[9].Name = "internal"
EXTRACTORSExtractorDoc.Fields[9].Type = "bool"
EXTRACTORSExtractorDoc.Fields[8].Description = "Extracts using DSL expressions."
EXTRACTORSExtractorDoc.Fields[8].Comments[encoder.LineComment] = "Extracts using DSL expressions."
EXTRACTORSExtractorDoc.Fields[9].Name = "part"
EXTRACTORSExtractorDoc.Fields[9].Type = "string"
EXTRACTORSExtractorDoc.Fields[9].Note = ""
EXTRACTORSExtractorDoc.Fields[9].Description = "Internal, when set to true will allow using the value extracted\nin the next request for some protocols (like HTTP)."
EXTRACTORSExtractorDoc.Fields[9].Comments[encoder.LineComment] = "Internal, when set to true will allow using the value extracted"
EXTRACTORSExtractorDoc.Fields[10].Name = "case-insensitive"
EXTRACTORSExtractorDoc.Fields[9].Description = "Part is the part of the request response to extract data from.\n\nEach protocol exposes a lot of different parts which are well\ndocumented in docs for each request type."
EXTRACTORSExtractorDoc.Fields[9].Comments[encoder.LineComment] = "Part is the part of the request response to extract data from."
EXTRACTORSExtractorDoc.Fields[9].AddExample("", "body")
EXTRACTORSExtractorDoc.Fields[9].AddExample("", "raw")
EXTRACTORSExtractorDoc.Fields[10].Name = "internal"
EXTRACTORSExtractorDoc.Fields[10].Type = "bool"
EXTRACTORSExtractorDoc.Fields[10].Note = ""
EXTRACTORSExtractorDoc.Fields[10].Description = "CaseInsensitive enables case-insensitive extractions. Default is false."
EXTRACTORSExtractorDoc.Fields[10].Comments[encoder.LineComment] = "CaseInsensitive enables case-insensitive extractions. Default is false."
EXTRACTORSExtractorDoc.Fields[10].Values = []string{
EXTRACTORSExtractorDoc.Fields[10].Description = "Internal, when set to true will allow using the value extracted\nin the next request for some protocols (like HTTP)."
EXTRACTORSExtractorDoc.Fields[10].Comments[encoder.LineComment] = "Internal, when set to true will allow using the value extracted"
EXTRACTORSExtractorDoc.Fields[11].Name = "case-insensitive"
EXTRACTORSExtractorDoc.Fields[11].Type = "bool"
EXTRACTORSExtractorDoc.Fields[11].Note = ""
EXTRACTORSExtractorDoc.Fields[11].Description = "CaseInsensitive enables case-insensitive extractions. Default is false."
EXTRACTORSExtractorDoc.Fields[11].Comments[encoder.LineComment] = "CaseInsensitive enables case-insensitive extractions. Default is false."
EXTRACTORSExtractorDoc.Fields[11].Values = []string{
"false",
"true",
}