Skip to content

Commit 42d5af0

Browse files
RDKDEV-1102: Update documentation for Network plugin to align with NetworkManger documentation (rdkcentral#5928)
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]> (picked from ce1f603)
1 parent 8ce8da8 commit 42d5af0

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

docs/api/NetworkPlugin.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
<!-- Generated automatically, DO NOT EDIT! -->
22
<a name="NetworkPlugin"></a>
3-
# NetworkPlugin
3+
# Network Plugin $${\color{red}(DEPRECATED)}$$
44

55
**Version: [1.3.11](https://github.com/rdkcentral/rdkservices/blob/main/Network/CHANGELOG.md)**
66

77
A org.rdk.Network plugin for Thunder framework.
88

9+
For newer APIs, please refer: https://github.com/rdkcentral/networkmanager/blob/main/docs/NetworkManagerPlugin.md
10+
911
### Table of Contents
1012

1113
- [Abbreviation, Acronyms and Terms](#Abbreviation,_Acronyms_and_Terms)
@@ -815,7 +817,7 @@ No Events
815817
| :-------- | :-------- | :-------- |
816818
| params | object | |
817819
| params.endpoint | string | The host name or IP address |
818-
| params.packets | integer | The number of packets to send. Default is 15 |
820+
| params.packets | integer | The number of packets to send. Default is 3 |
819821
| params?.guid | string | <sup>*(optional)*</sup> The globally unique identifier |
820822

821823
### Result
@@ -846,7 +848,7 @@ No Events
846848
"method": "org.rdk.Network.ping",
847849
"params": {
848850
"endpoint": "45.57.221.20",
849-
"packets": 10,
851+
"packets": 3,
850852
"guid": "..."
851853
}
852854
}
@@ -1303,7 +1305,7 @@ No Events
13031305
| :-------- | :-------- | :-------- |
13041306
| params | object | |
13051307
| params.endpoint | string | The host name or IP address |
1306-
| params.packets | integer | The number of packets to send. Default is 15 |
1308+
| params.packets | integer | The number of packets to send. Default is 5 |
13071309

13081310
### Result
13091311

@@ -1326,7 +1328,7 @@ No Events
13261328
"method": "org.rdk.Network.trace",
13271329
"params": {
13281330
"endpoint": "45.57.221.20",
1329-
"packets": 10
1331+
"packets": 5
13301332
}
13311333
}
13321334
```

docs/api/WifiPlugin.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
<!-- Generated automatically, DO NOT EDIT! -->
22
<a name="Wifi_Plugin"></a>
3-
# Wifi Plugin
3+
# Wifi Plugin $${\color{red}(DEPRECATED)}$$
44

55
**Version: [1.0.9](https://github.com/rdkcentral/rdkservices/blob/main/WifiManager/CHANGELOG.md)**
66

77
A org.rdk.Wifi plugin for Thunder framework.
88

9+
For newer APIs, please refer: https://github.com/rdkcentral/networkmanager/blob/main/docs/NetworkManagerPlugin.md
10+
911
### Table of Contents
1012

1113
- [Abbreviation, Acronyms and Terms](#Abbreviation,_Acronyms_and_Terms)

0 commit comments

Comments
 (0)