Auto Generate Syntax Docs + JSONSchema [Wed Sep 1 10:19:34 UTC 2021] 🤖

dev
GitHub Action 2021-09-01 10:19:34 +00:00
parent f3ed61b4c7
commit 9d0856e3c8
2 changed files with 3 additions and 4 deletions

View File

@ -18,8 +18,7 @@ Template is a YAML input file which defines all the requests and
</div>
<div class="dt">
ID is the unique id for the template. IDs must be lowercase
and must not contain spaces in it.
ID is the unique id for the template.
#### Good IDs

View File

@ -34,8 +34,8 @@ func init() {
TemplateDoc.Fields[0].Name = "id"
TemplateDoc.Fields[0].Type = "string"
TemplateDoc.Fields[0].Note = ""
TemplateDoc.Fields[0].Description = "ID is the unique id for the template. IDs must be lowercase\nand must not contain spaces in it.\n\n#### Good IDs\n\nA good ID uniquely identifies what the requests in the template\nare doing. Let's say you have a template that identifies a git-config\nfile on the webservers, a good name would be `git-config-exposure`. Another\nexample name is `azure-apps-nxdomain-takeover`."
TemplateDoc.Fields[0].Comments[encoder.LineComment] = "ID is the unique id for the template. IDs must be lowercase"
TemplateDoc.Fields[0].Description = "ID is the unique id for the template.\n\n#### Good IDs\n\nA good ID uniquely identifies what the requests in the template\nare doing. Let's say you have a template that identifies a git-config\nfile on the webservers, a good name would be `git-config-exposure`. Another\nexample name is `azure-apps-nxdomain-takeover`."
TemplateDoc.Fields[0].Comments[encoder.LineComment] = "ID is the unique id for the template."
TemplateDoc.Fields[0].AddExample("ID Example", "cve-2021-19520")
TemplateDoc.Fields[1].Name = "info"