Add general guidance for using the ZAP API with curl #247
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
Expanded the description for the addAlertFilter endpoint to include additional notes and requirements. Signed-off-by: SachinAditya <98205043+SachinAditya@users.noreply.github.com>
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 <98205043+SachinAditya@users.noreply.github.com>
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 <98205043+SachinAditya@users.noreply.github.com>
thc202
reviewed
Jan 3, 2026
This change moves the general curl usage guidance under the "Access the API" section, where the API URL format and access details are already introduced. The content remains general and avoids modifying any generated or endpoint-specific API documentation, following maintainer feedback. This improves the structure and readability of the documentation for users interacting with the ZAP API via curl. Signed-off-by: Sachin Vishwakarma <98205043+SachinAditya@users.noreply.github.com>
Contributor
Author
|
Hi @mentor-thc202 👋 |
thc202
reviewed
Jan 15, 2026
Signed-off-by: Sachin Vishwakarma <98205043+SachinAditya@users.noreply.github.com>
Contributor
Author
|
Good catch, you’re right — that statement was too strong. |
Signed-off-by: Sachin Vishwakarma <98205043+SachinAditya@users.noreply.github.com>
Contributor
Author
|
Thanks for pointing that out, you’re right. |
Contributor
Author
|
Thanks for the detailed review @thc202, much appreciated. I’ve now:
The PR should now only contain curl-specific guidance as discussed. Please let me know if anything else should be adjusted. |
Member
|
This is still pending #247 (comment) see the whole diff in https://github.com/zaproxy/zap-api-docs/pull/247/files |
Signed-off-by: Sachin Vishwakarma <98205043+SachinAditya@users.noreply.github.com>
Signed-off-by: Sachin Vishwakarma <98205043+SachinAditya@users.noreply.github.com>
Signed-off-by: Sachin Vishwakarma <98205043+SachinAditya@users.noreply.github.com>
Signed-off-by: Sachin Vishwakarma <98205043+SachinAditya@users.noreply.github.com>
thc202
approved these changes
Jan 16, 2026
Member
|
Thank you! |
kingthorin
reviewed
Jan 17, 2026
Comment on lines
109
to
110
| ``` | ||
| ### Client SDKs |
Member
There was a problem hiding this comment.
Please add a blank line between the code fence and heading.
Added a new section for Client SDKs in the welcome documentation. Signed-off-by: Sachin Vishwakarma <98205043+SachinAditya@users.noreply.github.com>
auto-merge was automatically disabled
January 17, 2026 13:20
Head branch was pushed to by a user without write access
kingthorin
approved these changes
Jan 17, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
This PR adds general guidance on using the ZAP API with curl,
focusing on parameter encoding, boolean parameters, and common
pitfalls when constructing API requests.
The documentation is added at a general level without modifying
any generated or endpoint-specific API definitions.
This follows feedback provided on PR #244 and Issue #88, by keeping
endpoint documentation unchanged while improving overall API
usability for users interacting with the ZAP API via curl.