Clarify alertFilter API documentation#244
Closed
SachinAditya wants to merge 1 commit intozaproxy:mainfrom
Closed
Conversation
Expanded the description for the addAlertFilter endpoint to include additional notes and requirements. Signed-off-by: SachinAditya <[email protected]>
Contributor
Author
|
Hi maintainers 👋 |
Member
|
This API definition is generated from the ZAP APIs, if you want to change the description you should do so in the respective API (Alert Filters is an add-on in zap-extensions repo). Note that the parameters already have their own description and the curl guidance should be a general comment in the API docs not of a specific API endpoint. |
SachinAditya
added a commit
to SachinAditya/zap-api-docs
that referenced
this pull request
Jan 2, 2026
This pull request adds general guidance on using the ZAP API with curl, focusing on common usage details such as parameter encoding, boolean parameters, and typical pitfalls when constructing API requests. The documentation is added at a general level (welcome/introduction), without modifying any generated or endpoint-specific API definitions. This change follows the feedback provided on PR zaproxy#244 and Issue zaproxy#88, by keeping endpoint documentation unchanged while improving overall API usability for users interacting with the ZAP API via curl. Signed-off-by: Sachin Vishwakarma <[email protected]>
SachinAditya
added a commit
to SachinAditya/zap-api-docs
that referenced
this pull request
Jan 2, 2026
This pull request adds general guidance on using the ZAP API with curl, focusing on common usage details such as parameter encoding, boolean parameters, and typical pitfalls when constructing API requests. The documentation is added at a general level (welcome/introduction), without modifying any generated or endpoint-specific API definitions. This change follows the feedback provided on PR zaproxy#244 and Issue zaproxy#88, by keeping endpoint documentation unchanged while improving overall API usability for users interacting with the ZAP API via curl. Signed-off-by: Sachin Vishwakarma <[email protected]>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Hi maintainers 👋
This PR improves the documentation for the
addAlertFilterendpoint as discussed in #88.Happy to update anything if needed. Thanks for your time!