Update AF templates and help #6949
Merged
+58
−8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ricekot
force-pushed
the
auto/update-docs
branch
from
66891d3 to
60a9f7c
Compare
thc202
reviewed
Nov 29, 2025
...main/javahelp/org/zaproxy/zap/extension/alertFilters/resources/help/contents/automation.html
Outdated
Show resolved
Hide resolved
.../reports/src/main/javahelp/org/zaproxy/addon/reports/resources/help/contents/automation.html
Outdated
Show resolved
Hide resolved
...c/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/contents/automation.html
Show resolved
Hide resolved
Member
|
Great job! No new security vulnerabilities introduced in this pull requestUse @Checkmarx to reach out to us for assistance. Just send a PR comment with Examples: |
kingthorin
reviewed
Nov 29, 2025
...c/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/contents/automation.html
Outdated
Show resolved
Hide resolved
ricekot
force-pushed
the
auto/update-docs
branch
from
60a9f7c to
36bf6e7
Compare
Copilot finished reviewing on behalf of
ricekot
December 5, 2025 03:16
There was a problem hiding this comment.
Pull request overview
This pull request updates Automation Framework templates and help documentation across multiple ZAP add-ons to ensure they accurately reflect all currently supported fields. The changes primarily add missing field documentation to YAML templates and correct minor inconsistencies in help files.
Key changes include:
- Adding comprehensive automation documentation for the wappalyzer add-on
- Updating template files to include previously undocumented fields
- Correcting parameter references in help documentation
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/toc.xml | Adds automation help entry to table of contents |
| addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/map.jhm | Maps automation help target to HTML file |
| addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/index.xml | Adds automation help to index |
| addOns/wappalyzer/src/main/javahelp/org/zaproxy/zap/extension/wappalyzer/resources/help/contents/automation.html | New help page documenting the wappalyzer automation job |
| addOns/wappalyzer/CHANGELOG.md | Documents the addition of automation help page |
| addOns/scripts/src/main/resources/org/zaproxy/zap/extension/scripts/resources/script-max.yaml | Adds missing inline field to template |
| addOns/scripts/src/main/javahelp/org/zaproxy/zap/extension/scripts/resources/help/contents/automation.html | Corrects parameter reference from 'file' to 'source' |
| addOns/scripts/CHANGELOG.md | Documents template update |
| addOns/reports/src/main/resources/org/zaproxy/addon/reports/resources/outputSummary-max.yaml | Adds missing rules configuration section |
| addOns/reports/CHANGELOG.md | Documents template update |
| addOns/client/src/main/resources/org/zaproxy/addon/client/resources/spiderClient-max.yaml | Adds missing scopeCheck field |
| addOns/client/CHANGELOG.md | Documents template update |
| addOns/alertFilters/src/main/resources/org/zaproxy/zap/extension/alertFilters/resources/alertFilter-max.yaml | Adds missing ruleName and methods fields |
| addOns/alertFilters/src/main/javahelp/org/zaproxy/zap/extension/alertFilters/resources/help/contents/automation.html | Adds missing ruleName and methods fields to help documentation |
| addOns/alertFilters/CHANGELOG.md | Documents template and help updates |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
kingthorin
approved these changes
Dec 5, 2025
Member
|
Needs rebase (at least one changelog update is out of the unreleased section). |
Signed-off-by: ricekot <git@ricekot.com>
ricekot
force-pushed
the
auto/update-docs
branch
from
36bf6e7 to
e7bca68
Compare
thc202
approved these changes
Dec 8, 2025
Member
|
Thank you! |
psiinon
approved these changes
Dec 8, 2025
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ensure that templates and help are up to date with supported fields.