From a876bf8d3c91ef245d57f57d9abb13f25c0bcc0f Mon Sep 17 00:00:00 2001
From: zapbot <12745184+zapbot@users.noreply.github.com>
Date: Wed, 11 Oct 2023 15:56:00 +0000
Subject: [PATCH] Update API docs

From:
zaproxy/zap-api-docs@4de71b2705fa6daa791aa567a97eb42f8360321b

Signed-off-by: zapbot <12745184+zapbot@users.noreply.github.com>
---
 docs/api/includes/welcome | 4 ++++
 docs/api/index.html       | 4 ++++
 2 files changed, 8 insertions(+)

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 <a href="https://www
 Also, if you are new to ZAP, then check out the <a href="https://www.zaproxy.org/getting-started/">getting started guide</a> 
 to learn the basic concepts behind ZAP. </p>
 
+<p>An <a href="https://swagger.io/">OpenAPI definition</a> for the ZAP API is <a href="https://raw.githubusercontent.com/zaproxy/zap-api-docs/main/openapi.yaml">available in the main repository</a>, 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.</p>
+
 <p>The following are some of the features provided by ZAP:</p>
 
 <ul>
diff --git a/docs/api/index.html b/docs/api/index.html
index 181c3f08f6..d6a03cfd1b 100644
--- a/docs/api/index.html
+++ b/docs/api/index.html
@@ -2568,6 +2568,10 @@ <h1 id='introduction'>Introduction</h1><h2 id='overview'>Overview</h2>
 Also, if you are new to ZAP, then check out the <a href="https://www.zaproxy.org/getting-started/">getting started guide</a> 
 to learn the basic concepts behind ZAP. </p>
 
+<p>An <a href="https://swagger.io/">OpenAPI definition</a> for the ZAP API is <a href="https://raw.githubusercontent.com/zaproxy/zap-api-docs/main/openapi.yaml">available in the main repository</a>, 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.</p>
+
 <p>The following are some of the features provided by ZAP:</p>
 
 <ul>