Skip to content

Commit 4de71b2

Browse files
authored
Merge pull request #181 from thc202/link-openapi.yaml
Link to the generated OpenAPI definition
2 parents e900adc + 6470cdf commit 4de71b2

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

source/includes/welcome.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ If anything is missing or seems incorrect, please check the [FAQs](https://www.z
1414
Also, if you are new to ZAP, then check out the [getting started guide](https://www.zaproxy.org/getting-started/)
1515
to learn the basic concepts behind ZAP.
1616

17+
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.
18+
This definition is planned to be kept up to date for the latest core and add-on releases.
19+
Note that currently the definition does not declare the most appropriate types for the parameters and does not contain the responses.
20+
1721
The following are some of the features provided by ZAP:
1822

1923
* Intercepting Proxy

0 commit comments

Comments
 (0)