Merge pull request #76 from thc202/update-apis

Update APIs of add-ons

Author: kingthorin

CHANGELOG.md

@@ -11,7 +11,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Core APIs updated for ZAP version 2.8.0.
 - Update Replacer API, per release of version 7.
-- Add description to Importurls API endpoint.
+- Update Websocket API, per release of version 19.
+- Update Selenium API, per release of version 15.0.0.
+- Add description to Importurls and AlertFilter API endpoints.
 
 ### Fixed
 - Disable XXE processing when parsing ZAP API responses.

subprojects/zap-clientapi/src/main/java/org/zaproxy/clientapi/gen/AlertFilter.java

@@ -35,16 +35,22 @@ public AlertFilter(ClientApi api) {
         this.api = api;
     }
 
-    /** This component is optional and therefore the API will only work if it is installed */
+    /**
+     * Lists the alert filters of the context with the given ID.
+     *
+     * <p>This component is optional and therefore the API will only work if it is installed
+     */
     public ApiResponse alertFilterList(String contextid) throws ClientApiException {
         Map<String, String> map = new HashMap<>();
-        if (contextid != null) {
-            map.put("contextId", contextid);
-        }
+        map.put("contextId", contextid);
         return api.callApi("alertFilter", "view", "alertFilterList", map);
     }
 
-    /** This component is optional and therefore the API will only work if it is installed */
+    /**
+     * Adds a new alert filter for the context with the given ID.
+     *
+     * <p>This component is optional and therefore the API will only work if it is installed
+     */
     public ApiResponse addAlertFilter(
             String contextid,
             String ruleid,
@@ -73,7 +79,11 @@ public ApiResponse addAlertFilter(
         return api.callApi("alertFilter", "action", "addAlertFilter", map);
     }
 
-    /** This component is optional and therefore the API will only work if it is installed */
+    /**
+     * Removes an alert filter from the context with the given ID.
+     *
+     * <p>This component is optional and therefore the API will only work if it is installed
+     */
     public ApiResponse removeAlertFilter(
             String contextid,
             String ruleid,

subprojects/zap-clientapi/src/main/java/org/zaproxy/clientapi/gen/Selenium.java

@@ -63,11 +63,8 @@ public ApiResponse optionFirefoxDriverPath() throws ClientApiException {
         return api.callApi("selenium", "view", "optionFirefoxDriverPath", null);
     }
 
-    /**
-     * Returns the current path to IEDriverServer
-     *
-     * <p>This component is optional and therefore the API will only work if it is installed
-     */
+    /** This component is optional and therefore the API will only work if it is installed */
+    @Deprecated
     public ApiResponse optionIeDriverPath() throws ClientApiException {
         return api.callApi("selenium", "view", "optionIeDriverPath", null);
     }
@@ -114,11 +111,8 @@ public ApiResponse setOptionFirefoxDriverPath(String string) throws ClientApiExc
         return api.callApi("selenium", "action", "setOptionFirefoxDriverPath", map);
     }
 
-    /**
-     * Sets the current path to IEDriverServer
-     *
-     * <p>This component is optional and therefore the API will only work if it is installed
-     */
+    /** This component is optional and therefore the API will only work if it is installed */
+    @Deprecated
     public ApiResponse setOptionIeDriverPath(String string) throws ClientApiException {
         Map<String, String> map = new HashMap<>();
         map.put("String", string);

subprojects/zap-clientapi/src/main/java/org/zaproxy/clientapi/gen/Websocket.java

@@ -83,6 +83,15 @@ public ApiResponse messages(
         return api.callApi("websocket", "view", "messages", map);
     }
 
+    /**
+     * Returns a text representation of an intercepted websockets message
+     *
+     * <p>This component is optional and therefore the API will only work if it is installed
+     */
+    public ApiResponse breakTextMessage() throws ClientApiException {
+        return api.callApi("websocket", "view", "breakTextMessage", null);
+    }
+
     /**
      * Sends the specified message on the channel specified by channelId, if outgoing is 'True' then
      * the message will be sent to the server and if it is 'False' then it will be sent to the
@@ -98,4 +107,17 @@ public ApiResponse sendTextMessage(String channelid, String outgoing, String mes
         map.put("message", message);
         return api.callApi("websocket", "action", "sendTextMessage", map);
     }
+
+    /**
+     * Sets the text message for an intercepted websockets message
+     *
+     * <p>This component is optional and therefore the API will only work if it is installed
+     */
+    public ApiResponse setBreakTextMessage(String message, String outgoing)
+            throws ClientApiException {
+        Map<String, String> map = new HashMap<>();
+        map.put("message", message);
+        map.put("outgoing", outgoing);
+        return api.callApi("websocket", "action", "setBreakTextMessage", map);
+    }
 }