Merge pull request #6781 from thc202/scanpolicies/doc-names

scanpolicies: document programmatic names

Author: kingthorin

addOns/scanpolicies/CHANGELOG.md

@@ -4,7 +4,8 @@ All notable changes to this add-on will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## Unreleased
-
+### Added
+- Document in the help the programmatic name of the policies.
 
 ## [0.5.0] - 2025-09-18
 ### Changed

addOns/scanpolicies/src/main/javahelp/help/contents/policy-api.html

@@ -13,6 +13,9 @@ <H1>API Policy</H1>
 <p>
 For the list of scan rules included see the <a href="https://www.zaproxy.org/alerttags/policy_api/">Alert Tag: POLICY_API</a> page.
 <p>
+Programmatic Name: <code>API</code>
+</p>
+<p>
 Return to <a href="scanpolicies.html">main scan policies page</a>.
 
 </BODY>

addOns/scanpolicies/src/main/javahelp/help/contents/policy-default.html

@@ -11,6 +11,9 @@ <H1>Default Policy</H1>
 
 A policy which enables all of the installed active scan rules.
 <p>
+Programmatic Name: <code>Default Policy</code>
+</p>
+<p>
 Return to <a href="scanpolicies.html">main scan policies page</a>.
 </BODY>
 </HTML>

addOns/scanpolicies/src/main/javahelp/help/contents/policy-dev-cicd.html

@@ -23,6 +23,9 @@ <H1>Developer CI/CD Policy</H1>
 <p>
 For the list of scan rules included see the <a href="https://www.zaproxy.org/alerttags/policy_dev_cicd/">Alert Tag: POLICY_DEV_CICD</a> page.
 <p>
+Programmatic Name: <code>Dev CICD</code>
+</p>
+<p>
 Return to <a href="scanpolicies.html">main scan policies page</a>.
 
 </BODY>

addOns/scanpolicies/src/main/javahelp/help/contents/policy-dev-full.html

@@ -22,6 +22,9 @@ <H1>Developer Full Policy</H1>
 <p>
 For the list of scan rules included see the <a href="https://www.zaproxy.org/alerttags/policy_dev_full/">Alert Tag: POLICY_DEV_FULL</a> page.
 <p>
+Programmatic Name: <code>Dev Full</code>
+</p>
+<p>
 Return to <a href="scanpolicies.html">main scan policies page</a>.
 
 </BODY>

addOns/scanpolicies/src/main/javahelp/help/contents/policy-dev-std.html

@@ -24,6 +24,9 @@ <H1>Developer Standard Policy</H1>
 <p>
 For the list of scan rules included see the <a href="https://www.zaproxy.org/alerttags/policy_dev_std/">Alert Tag: POLICY_DEV_STD</a> page.
 <p>
+Programmatic Name: <code>Dev Standard</code>
+</p>
+<p>
 Return to <a href="scanpolicies.html">main scan policies page</a>.
 
 </BODY>

addOns/scanpolicies/src/main/javahelp/help/contents/policy-pentest.html

@@ -11,6 +11,9 @@ <H1>Penetration Tester Policy</H1>
 
 A policy which enables all of the installed active scan rules with the exception of the Example rules.
 <p>
+Programmatic Name: <code>Pen Test</code>
+</p>
+<p>
 Return to <a href="scanpolicies.html">main scan policies page</a>.
 </BODY>
 </HTML>

addOns/scanpolicies/src/main/javahelp/help/contents/policy-qa-cicd.html

@@ -26,6 +26,9 @@ <H1>QA CI/CD Policy</H1>
 <p>
 For the list of scan rules included see the <a href="https://www.zaproxy.org/alerttags/policy_qa_cicd/">Alert Tag: POLICY_QA_CICD</a> page.
 <p>
+Programmatic Name: <code>QA CICD</code>
+</p>
+<p>
 Return to <a href="scanpolicies.html">main scan policies page</a>.
 
 </BODY>

addOns/scanpolicies/src/main/javahelp/help/contents/policy-qa-full.html

@@ -19,6 +19,9 @@ <H1>QA Full Policy</H1>
 <p>
 For the list of scan rules included see the <a href="https://www.zaproxy.org/alerttags/policy_qa_full/">Alert Tag: POLICY_QA_FULL</a> page.
 <p>
+Programmatic Name: <code>QA Full</code>
+</p>
+<p>
 Return to <a href="scanpolicies.html">main scan policies page</a>.
 
 </BODY>

addOns/scanpolicies/src/main/javahelp/help/contents/policy-qa-std.html

@@ -20,6 +20,9 @@ <H1>QA Standard Policy</H1>
 <p>
 For the list of scan rules included see the <a href="https://www.zaproxy.org/alerttags/policy_qa_std/">Alert Tag: POLICY_QA_STD</a> page.
 <p>
+Programmatic Name: <code>QA Standard</code>
+</p>
+<p>
 Return to <a href="scanpolicies.html">main scan policies page</a>.
 
 </BODY>