Skip to content

Commit 21fcd6c

Browse files
W0lfbanekingthorin
andauthored
Update addOns/openapi/src/main/javahelp/org/zaproxy/zap/extension/openapi/resources/help/contents/openapi.html
Co-authored-by: Rick M <[email protected]> Signed-off-by: W0lfbane <[email protected]>
1 parent 8d7fc18 commit 21fcd6c

File tree

1 file changed

+1
-1
lines changed
  • addOns/openapi/src/main/javahelp/org/zaproxy/zap/extension/openapi/resources/help/contents

1 file changed

+1
-1
lines changed

addOns/openapi/src/main/javahelp/org/zaproxy/zap/extension/openapi/resources/help/contents/openapi.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<H1>OpenAPI Support</H1>
1111
This add-on allows you to spider and import OpenAPI (Swagger) definitions, versions 1.2, 2.0, and 3.0.
1212
<br>
13-
<strong>Note:</strong> The add-on can generate XML request bodies for XML media types (for example, <code>application/xml</code>, <code>text/xml</code>, and <code>application/*+xml</code>). If an explicit example is provided in the OpenAPI media type that example will be used; otherwise the add-on will attempt to generate a best-effort XML example from the schema. The generator attempts to honour XML-specific metadata (such as <code>xml.name</code>, <code>xml.namespace</code>, <code>xml.prefix</code>, <code>xml.attribute</code> and <code>xml.wrapped</code>), but generation can fail for complex or invalid schemas. If generation fails an error is logged and surfaced and an empty body may be returned — you can also supply a hand-crafted example in the OpenAPI spec or edit the request body manually.
13+
<strong>Note:</strong> The add-on can generate XML request bodies for XML media types (for example, <code>application/xml</code>, <code>text/xml</code>, and <code>application/*+xml</code>). If an explicit example is provided in the OpenAPI media type that example will be used; otherwise the add-on will attempt to generate a best-effort XML example from the schema. The generator attempts to honour XML-specific metadata (such as <code>xml.name</code>, <code>xml.namespace</code>, <code>xml.prefix</code>, <code>xml.attribute</code>, and <code>xml.wrapped</code>). Generation can fail for complex or invalid schemas. If generation fails an error is logged and surfaced, and an empty body may be returned — you can also supply a hand-crafted example in the OpenAPI spec or edit the request body manually.
1414
<br><br>
1515
The add-on will automatically detect any OpenAPI definitions and spider them as long as they are in scope.
1616
<br><br>

0 commit comments

Comments
 (0)