diff --git a/docs/api/includes/welcome b/docs/api/includes/welcome index b91002e024..3a299d097a 100644 --- a/docs/api/includes/welcome +++ b/docs/api/includes/welcome @@ -11,6 +11,10 @@ If anything is missing or seems incorrect, please check the getting started guide to learn the basic concepts behind ZAP.

+

An OpenAPI definition for the ZAP API is available in the main repository, 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: