Merge pull request #5747 from thc202/openapi/update-docs

openapi: update docs to match latest behaviour
zaproxy · Sep 20, 2024 · ee271ca · ee271ca
2 parents c368fb9 + d3a4aeb
commit ee271ca
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/...c/main/javahelp/org/zaproxy/zap/extension/openapi/resources/help/contents/automation.html b/...c/main/javahelp/org/zaproxy/zap/extension/openapi/resources/help/contents/automation.html
@@ -23,7 +23,7 @@ <H2>Job: openapi</H2>
     parameters:
       apiFile:                         # String: Local file containing the OpenAPI definition, default: null, no definition will be imported
       apiUrl:                          # String: URL containing the OpenAPI definition, default: null, no definition will be imported
-      context:                         # String: Context to use when importing the OpenAPI definition, default: null, no context will be used
+      context:                         # String: Context to use when importing the OpenAPI definition, default: first context.
       user:                            # String: An optional user to use for authentication, must be defined in the env.
       targetUrl:                       # String: URL which overrides the target defined in the definition, default: null, the target will not be overridden
 </pre>

diff --git a/...s/openapi/src/main/resources/org/zaproxy/zap/extension/openapi/resources/openapi-max.yaml b/...s/openapi/src/main/resources/org/zaproxy/zap/extension/openapi/resources/openapi-max.yaml
@@ -2,6 +2,6 @@
     parameters:
       apiFile:                         # String: Local file containing the OpenAPI definition, default: null, no definition will be imported
       apiUrl:                          # String: URL containing the OpenAPI definition, default: null, no definition will be imported
-      context:                         # String: Context to use when importing the OpenAPI definition, default: null, no context will be used
+      context:                         # String: Context to use when importing the OpenAPI definition, default: first context.
       user:                            # String: An optional user to use for authentication, must be defined in the env.
       targetUrl:                       # String: URL which overrides the target defined in the definition, default: null, the target will not be overridden
diff --git a/...s/openapi/src/main/resources/org/zaproxy/zap/extension/openapi/resources/openapi-min.yaml b/...s/openapi/src/main/resources/org/zaproxy/zap/extension/openapi/resources/openapi-min.yaml
@@ -2,5 +2,5 @@
     parameters:
       apiFile:                         # String: Local file containing the OpenAPI definition, default: null, no definition will be imported
       apiUrl:                          # String: URL containing the OpenAPI definition, default: null, no definition will be imported
-      context:                         # String: Context to use when importing the OpenAPI definition, default: null, no context will be used
+      context:                         # String: Context to use when importing the OpenAPI definition, default: first context.
       targetUrl:                       # String: URL which overrides the target defined in the definition, default: null, the target will not be overridden