Auto Generate Syntax Docs + JSONSchema [Fri Sep 3 13:50:44 UTC 2021] 🤖

2021-09-03 13:50:44 +00:00 · 2021-09-03 13:50:44 +00:00 · c256bef362
parent 16a54e3b98
commit c256bef362
3 changed files with 82 additions and 45 deletions
--- a/SYNTAX-REFERENCE.md
+++ b/SYNTAX-REFERENCE.md
@ -282,7 +282,7 @@ name: Nagios Default Credentials Check

 <div class="dd">

-<code>author</code>  <i>StringSlice</i>
+<code>author</code>  <i><a href="#stringslicestringslice">stringslice.StringSlice</a></i>

 </div>
 <div class="dt">
@ -307,7 +307,7 @@ author: <username>

 <div class="dd">

-<code>tags</code>  <i>StringSlice</i>
+<code>tags</code>  <i><a href="#stringslicestringslice">stringslice.StringSlice</a></i>

 </div>
 <div class="dt">
@ -362,7 +362,7 @@ description: Subversion ALM for the enterprise before 8.8.2 allows reflected XSS

 <div class="dd">

-<code>reference</code>  <i>StringSlice</i>
+<code>reference</code>  <i><a href="#stringslicestringslice">stringslice.StringSlice</a></i>

 </div>
 <div class="dt">
@ -389,7 +389,7 @@ reference:

 <div class="dd">

-<code>severity</code>  <i><a href="#severityseverityholder">severity.SeverityHolder</a></i>
+<code>severity</code>  <i><a href="#severityholder">severity.Holder</a></i>

 </div>
 <div class="dt">
@ -441,18 +441,38 @@ additional-fields:



-## model.StringSlice
+## stringslice.StringSlice
+StringSlice represents a single (in-lined) or multiple string value(s).
+ The unmarshaller does not automatically convert in-lined strings to []string, hence the interface{} type is required.

 Appears in:


+- <code><a href="#modelinfo">model.Info</a>.author</code>
+
+- <code><a href="#modelinfo">model.Info</a>.tags</code>
+
+- <code><a href="#modelinfo">model.Info</a>.reference</code>
+
 - <code><a href="#workflowsworkflowtemplate">workflows.WorkflowTemplate</a>.tags</code>


+```yaml
+<username>
+```
+```yaml
+# Example tags
+cve,cve2019,grafana,auth-bypass,dos
+```
+```yaml
+- https://github.com/strapi/strapi
+- https://github.com/getgrav/grav
+```



-## severity.SeverityHolder
+## severity.Holder
+Holder holds a Severity type. Required for un/marshalling purposes

 Appears in:

@ -2617,7 +2637,7 @@ template: misconfigurations/aem

 <div class="dd">

-<code>tags</code>  <i><a href="#modelstringslice">model.StringSlice</a></i>
+<code>tags</code>  <i><a href="#stringslicestringslice">stringslice.StringSlice</a></i>

 </div>
 <div class="dt">
--- a/nuclei-jsonschema.json
+++ b/nuclei-jsonschema.json
@ -2,18 +2,6 @@
  "$schema": "http://json-schema.org/draft-04/schema#",
  "$ref": "#/definitions/templates.Template",
  "definitions": {
-    "severity.SeverityHolder": {
-      "enum": [
-        "info",
-        "low",
-        "medium",
-        "high",
-        "critical"
-      ],
-      "type": "string",
-      "title": "severity of the template",
-      "description": "Seriousness of the implications of the template"
-    },
    "model.Info": {
      "properties": {
        "name": {
@ -26,12 +14,12 @@
        },
        "author": {
          "$schema": "http://json-schema.org/draft-04/schema#",
-          "$ref": "#/definitions/model.StringSlice",
+          "$ref": "#/definitions/stringslice.StringSlice",
          "title": "author of the template",
          "description": "Author is the author of the template"
        },
        "tags": {
-          "$ref": "#/definitions/model.StringSlice",
+          "$ref": "#/definitions/stringslice.StringSlice",
          "title": "tags of the template",
          "description": "Any tags for the template"
        },
@ -44,13 +32,13 @@
          ]
        },
        "reference": {
-          "$ref": "#/definitions/model.StringSlice",
+          "$ref": "#/definitions/stringslice.StringSlice",
          "title": "references for the template",
          "description": "Links relevant to the template"
        },
        "severity": {
          "$schema": "http://json-schema.org/draft-04/schema#",
-          "$ref": "#/definitions/severity.SeverityHolder"
+          "$ref": "#/definitions/severity.Holder"
        },
        "additional-fields": {
          "patternProperties": {
@ -66,7 +54,19 @@
      "additionalProperties": false,
      "type": "object"
    },
-    "model.StringSlice": {
+    "severity.Holder": {
+      "enum": [
+        "info",
+        "low",
+        "medium",
+        "high",
+        "critical"
+      ],
+      "type": "string",
+      "title": "severity of the template",
+      "description": "Seriousness of the implications of the template"
+    },
+    "stringslice.StringSlice": {
      "oneOf": [
        {
          "type": "string"
@ -885,7 +885,7 @@
          "description": "Template or directory to execute as part of workflow"
        },
        "tags": {
-          "$ref": "#/definitions/model.StringSlice",
+          "$ref": "#/definitions/stringslice.StringSlice",
          "title": "tags to execute",
          "description": "Tags to run template based on"
        },
--- a/v2/pkg/templates/templates_doc.go
+++ b/v2/pkg/templates/templates_doc.go
@ -1,4 +1,3 @@
-// Package templates
 // This Source Code Form is subject to the terms of the Mozilla Public
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
@ -12,8 +11,8 @@ import (
 var (
 	TemplateDoc                  encoder.Doc
 	MODELInfoDoc                 encoder.Doc
-	MODELStringSliceDoc          encoder.Doc
-	SEVERITYSeverityHolderDoc    encoder.Doc
+	STRINGSLICEStringSliceDoc    encoder.Doc
+	SEVERITYHolderDoc            encoder.Doc
 	HTTPRequestDoc               encoder.Doc
 	MATCHERSMatcherDoc           encoder.Doc
 	EXTRACTORSExtractorDoc       encoder.Doc
@ -107,14 +106,14 @@ func init() {

 	MODELInfoDoc.Fields[0].AddExample("", "Nagios Default Credentials Check")
 	MODELInfoDoc.Fields[1].Name = "author"
-	MODELInfoDoc.Fields[1].Type = "StringSlice"
+	MODELInfoDoc.Fields[1].Type = "stringslice.StringSlice"
 	MODELInfoDoc.Fields[1].Note = ""
 	MODELInfoDoc.Fields[1].Description = "Author of the template.\n\nMultiple values can also be specified separated by commas."
 	MODELInfoDoc.Fields[1].Comments[encoder.LineComment] = "Author of the template."

 	MODELInfoDoc.Fields[1].AddExample("", "<username>")
 	MODELInfoDoc.Fields[2].Name = "tags"
-	MODELInfoDoc.Fields[2].Type = "StringSlice"
+	MODELInfoDoc.Fields[2].Type = "stringslice.StringSlice"
 	MODELInfoDoc.Fields[2].Note = ""
 	MODELInfoDoc.Fields[2].Description = "Any tags for the template.\n\nMultiple values can also be specified separated by commas."
 	MODELInfoDoc.Fields[2].Comments[encoder.LineComment] = "Any tags for the template."
@ -130,14 +129,14 @@ func init() {

 	MODELInfoDoc.Fields[3].AddExample("", "Subversion ALM for the enterprise before 8.8.2 allows reflected XSS at multiple locations")
 	MODELInfoDoc.Fields[4].Name = "reference"
-	MODELInfoDoc.Fields[4].Type = "StringSlice"
+	MODELInfoDoc.Fields[4].Type = "stringslice.StringSlice"
 	MODELInfoDoc.Fields[4].Note = ""
 	MODELInfoDoc.Fields[4].Description = "References for the template.\n\nThis should contain links relevant to the template."
 	MODELInfoDoc.Fields[4].Comments[encoder.LineComment] = "References for the template."

 	MODELInfoDoc.Fields[4].AddExample("", []string{"https://github.com/strapi/strapi", "https://github.com/getgrav/grav"})
 	MODELInfoDoc.Fields[5].Name = "severity"
-	MODELInfoDoc.Fields[5].Type = "severity.SeverityHolder"
+	MODELInfoDoc.Fields[5].Type = "severity.Holder"
 	MODELInfoDoc.Fields[5].Note = ""
 	MODELInfoDoc.Fields[5].Description = "Severity of the template."
 	MODELInfoDoc.Fields[5].Comments[encoder.LineComment] = "Severity of the template."
@ -156,27 +155,45 @@ func init() {

 	MODELInfoDoc.Fields[6].AddExample("", map[string]string{"customField1": "customValue1"})

-	MODELStringSliceDoc.Type = "model.StringSlice"
-	MODELStringSliceDoc.Comments[encoder.LineComment] = ""
-	MODELStringSliceDoc.Description = ""
-	MODELStringSliceDoc.AppearsIn = []encoder.Appearance{
+	STRINGSLICEStringSliceDoc.Type = "stringslice.StringSlice"
+	STRINGSLICEStringSliceDoc.Comments[encoder.LineComment] = " StringSlice represents a single (in-lined) or multiple string value(s)."
+	STRINGSLICEStringSliceDoc.Description = "StringSlice represents a single (in-lined) or multiple string value(s).\n The unmarshaller does not automatically convert in-lined strings to []string, hence the interface{} type is required."
+
+	STRINGSLICEStringSliceDoc.AddExample("", "<username>")
+
+	STRINGSLICEStringSliceDoc.AddExample("Example tags", "cve,cve2019,grafana,auth-bypass,dos")
+
+	STRINGSLICEStringSliceDoc.AddExample("", []string{"https://github.com/strapi/strapi", "https://github.com/getgrav/grav"})
+	STRINGSLICEStringSliceDoc.AppearsIn = []encoder.Appearance{
+		{
+			TypeName:  "model.Info",
+			FieldName: "author",
+		},
+		{
+			TypeName:  "model.Info",
+			FieldName: "tags",
+		},
+		{
+			TypeName:  "model.Info",
+			FieldName: "reference",
+		},
 		{
 			TypeName:  "workflows.WorkflowTemplate",
 			FieldName: "tags",
 		},
 	}
-	MODELStringSliceDoc.Fields = make([]encoder.Doc, 0)
+	STRINGSLICEStringSliceDoc.Fields = make([]encoder.Doc, 0)

-	SEVERITYSeverityHolderDoc.Type = "severity.SeverityHolder"
-	SEVERITYSeverityHolderDoc.Comments[encoder.LineComment] = ""
-	SEVERITYSeverityHolderDoc.Description = ""
-	SEVERITYSeverityHolderDoc.AppearsIn = []encoder.Appearance{
+	SEVERITYHolderDoc.Type = "severity.Holder"
+	SEVERITYHolderDoc.Comments[encoder.LineComment] = " Holder holds a Severity type. Required for un/marshalling purposes"
+	SEVERITYHolderDoc.Description = "Holder holds a Severity type. Required for un/marshalling purposes"
+	SEVERITYHolderDoc.AppearsIn = []encoder.Appearance{
 		{
 			TypeName:  "model.Info",
 			FieldName: "severity",
 		},
 	}
-	SEVERITYSeverityHolderDoc.Fields = make([]encoder.Doc, 0)
+	SEVERITYHolderDoc.Fields = make([]encoder.Doc, 0)

 	HTTPRequestDoc.Type = "http.Request"
 	HTTPRequestDoc.Comments[encoder.LineComment] = " Request contains a http request to be made from a template"
@ -971,7 +988,7 @@ func init() {

 	WORKFLOWSWorkflowTemplateDoc.Fields[0].AddExample("A template directory", "misconfigurations/aem")
 	WORKFLOWSWorkflowTemplateDoc.Fields[1].Name = "tags"
-	WORKFLOWSWorkflowTemplateDoc.Fields[1].Type = "model.StringSlice"
+	WORKFLOWSWorkflowTemplateDoc.Fields[1].Type = "stringslice.StringSlice"
 	WORKFLOWSWorkflowTemplateDoc.Fields[1].Note = ""
 	WORKFLOWSWorkflowTemplateDoc.Fields[1].Description = "Tags to run templates based on."
 	WORKFLOWSWorkflowTemplateDoc.Fields[1].Comments[encoder.LineComment] = "Tags to run templates based on."
@ -1016,8 +1033,8 @@ func GetTemplateDoc() *encoder.FileDoc {
 		Structs: []*encoder.Doc{
 			&TemplateDoc,
 			&MODELInfoDoc,
-			&MODELStringSliceDoc,
-			&SEVERITYSeverityHolderDoc,
+			&STRINGSLICEStringSliceDoc,
+			&SEVERITYHolderDoc,
 			&HTTPRequestDoc,
 			&MATCHERSMatcherDoc,
 			&EXTRACTORSExtractorDoc,