From 6470cdfe072fc8ce8fc32300791e12f573aa2646 Mon Sep 17 00:00:00 2001 From: thc202 Date: Wed, 11 Oct 2023 16:49:48 +0100 Subject: [PATCH] Link to the generated OpenAPI definition Add sentence linking to the OpenAPI definition in the repo. Signed-off-by: thc202 --- source/includes/welcome.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/includes/welcome.md b/source/includes/welcome.md index 8f690eb..54c76f9 100755 --- a/source/includes/welcome.md +++ b/source/includes/welcome.md @@ -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