Skip to content

Commit

Permalink
Update API docs
Browse files Browse the repository at this point in the history
From:
zaproxy/zap-api-docs@4de71b2

Signed-off-by: zapbot <12745184+zapbot@users.noreply.github.com>
  • Loading branch information
zapbot committed Oct 11, 2023
1 parent 3f23837 commit a876bf8
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/api/includes/welcome
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
4 changes: 4 additions & 0 deletions docs/api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down

0 comments on commit a876bf8

Please sign in to comment.