Add query help template in markdown format

This commit is contained in:
Michael Hohn
2024-04-17 11:29:59 -07:00
committed by =Michael Hohn
parent f865a134cc
commit 561552bbee
2 changed files with 26 additions and 0 deletions

View File

@@ -129,3 +129,11 @@
...
#+END_SRC
** (optional) Write query help
Help is included from a markdown file. For a query =foo.ql= the file =foo.md=
is included in the SARIF output when the
: --sarif-include-query-help=always
flag is set.
To write such a help file, copy the template in [[./help-template.md]] and
customize the content.

18
session/help-template.md Normal file
View File

@@ -0,0 +1,18 @@
# SQLI Vulnerability
Loops can ...
## Recommendation
When writing...
## Example
The following example ...
```java
import java.sql.Connection;
...
```
The solution is ...
## References
* Java Language Specification: [Blocks and Statements](https://docs.oracle.com/javase/specs/jls/se11/html/jls-14.html).