Skip to content

Commit

Permalink
Merge pull request #181 from thc202/link-openapi.yaml
Browse files Browse the repository at this point in the history
Link to the generated OpenAPI definition
  • Loading branch information
psiinon authored Oct 11, 2023
2 parents e900adc + 6470cdf commit 4de71b2
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions source/includes/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ If anything is missing or seems incorrect, please check the [FAQs](https://www.z
Also, if you are new to ZAP, then check out the [getting started guide](https://www.zaproxy.org/getting-started/)
to learn the basic concepts behind ZAP.

An [OpenAPI definition](https://swagger.io/) for the ZAP API is [available in the main repository](https://raw.githubusercontent.com/zaproxy/zap-api-docs/main/openapi.yaml), which can be used to generate custom API clients.
This definition is planned to be kept up to date for the latest core and add-on releases.
Note that currently the definition does not declare the most appropriate types for the parameters and does not contain the responses.

The following are some of the features provided by ZAP:

* Intercepting Proxy
Expand Down

0 comments on commit 4de71b2

Please sign in to comment.