RDKDEV-1102: Update documentation for Network plugin to align with Ne…

…tworkManger documentation (rdkcentral#5862) * RDKDEV-1102: Update documentation for Network plugin to align with NetworkManger documentation Reason for change: Align Network plugin documention with NetworkManager documention update Risks: Low Test Procedure: Verify default packet sizes for ping and trace APIs in https://rdkcentral.github.io/rdkservices/#/api/NetworkPlugin is aligned with https://github.com/rdkcentral/networkmanager/blob/develop/docs/NetworkManagerPlugin.md Signed-off-by: Jitha James <[email protected]> Co-authored-by: Karunakaran A <[email protected]>
LibertyGlobal · Nov 26, 2024 · ce1f603 · ce1f603
1 parent b65a0c1
commit ce1f603
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/docs/api/NetworkPlugin.md b/docs/api/NetworkPlugin.md
@@ -1,11 +1,13 @@
 <!-- Generated automatically, DO NOT EDIT! -->
 <a name="NetworkPlugin"></a>
-# NetworkPlugin
+# Network Plugin $${\color{red}(DEPRECATED)}$$
 
 **Version: [1.3.11](https://github.com/rdkcentral/rdkservices/blob/main/Network/CHANGELOG.md)**
 
 A org.rdk.Network plugin for Thunder framework.
 
+For newer APIs, please refer: https://github.com/rdkcentral/networkmanager/blob/main/docs/NetworkManagerPlugin.md
+
 ### Table of Contents
 
 - [Abbreviation, Acronyms and Terms](#Abbreviation,_Acronyms_and_Terms)
@@ -815,7 +817,7 @@ No Events
 | :-------- | :-------- | :-------- |
 | params | object |  |
 | params.endpoint | string | The host name or IP address |
-| params.packets | integer | The number of packets to send. Default is 15 |
+| params.packets | integer | The number of packets to send. Default is 3 |
 | params?.guid | string | <sup>*(optional)*</sup> The globally unique identifier |
 
 ### Result
@@ -846,7 +848,7 @@ No Events
     "method": "org.rdk.Network.ping",
     "params": {
         "endpoint": "45.57.221.20",
-        "packets": 10,
+        "packets": 3,
         "guid": "..."
     }
 }
@@ -1303,7 +1305,7 @@ No Events
 | :-------- | :-------- | :-------- |
 | params | object |  |
 | params.endpoint | string | The host name or IP address |
-| params.packets | integer | The number of packets to send. Default is 15 |
+| params.packets | integer | The number of packets to send. Default is 5 |
 
 ### Result
 
@@ -1326,7 +1328,7 @@ No Events
     "method": "org.rdk.Network.trace",
     "params": {
         "endpoint": "45.57.221.20",
-        "packets": 10
+        "packets": 5
     }
 }
 ```

diff --git a/docs/api/WifiPlugin.md b/docs/api/WifiPlugin.md
@@ -1,11 +1,13 @@
 <!-- Generated automatically, DO NOT EDIT! -->
 <a name="Wifi_Plugin"></a>
-# Wifi Plugin
+# Wifi Plugin $${\color{red}(DEPRECATED)}$$
 
 **Version: [1.0.9](https://github.com/rdkcentral/rdkservices/blob/main/WifiManager/CHANGELOG.md)**
 
 A org.rdk.Wifi plugin for Thunder framework.
 
+For newer APIs, please refer: https://github.com/rdkcentral/networkmanager/blob/main/docs/NetworkManagerPlugin.md
+
 ### Table of Contents
 
 - [Abbreviation, Acronyms and Terms](#Abbreviation,_Acronyms_and_Terms)