From ce1f603a9e417e34921663c75cb5e4004520cb27 Mon Sep 17 00:00:00 2001 From: jithajamesp <159991474+jithajamesp@users.noreply.github.com> Date: Tue, 26 Nov 2024 20:30:59 +0530 Subject: [PATCH] RDKDEV-1102: Update documentation for Network plugin to align with NetworkManger documentation (#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 Co-authored-by: Karunakaran A <48997923+karuna2git@users.noreply.github.com> --- docs/api/NetworkPlugin.md | 12 +++++++----- docs/api/WifiPlugin.md | 4 +++- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/api/NetworkPlugin.md b/docs/api/NetworkPlugin.md index 8750486715..5d06991fdd 100644 --- a/docs/api/NetworkPlugin.md +++ b/docs/api/NetworkPlugin.md @@ -1,11 +1,13 @@ -# 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 | *(optional)* 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 index 5fc91c5afa..ca95f936b2 100644 --- a/docs/api/WifiPlugin.md +++ b/docs/api/WifiPlugin.md @@ -1,11 +1,13 @@ -# 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)