OpenAPI doc improvement in radio setting

OpenAPI doc improvement in radio setting

OpenAPI doc improvement in radio setting
OpenAPI doc improvement in radio setting
2025-05-26 14:44:37 - last edited 2025-05-28 09:05:33
Model: OC300  
Hardware Version:
Firmware Version:

Hello,

 

When deploying tens of AP, it's important te be consistently configure radio settings, above all in 2.4GHz band.

Omada Open API can be very helpful to do this efficiently without using GUI.

 

Looking at [1], I think current doc may become even more useful, if some provided examples or explaination text were re-phrased or more detailed.

 

For instance, you need to move one AP from channel 1 to channel 6. How can you do that ?

Doc says you can use Channel setting to do that.

Channel setting definition is:

 

"Channel Index; The channel index list supported by device can be obtained from interface : Get available channel list of ap; If select auto configuration need to enter 0.".

 

But when you look at provided examples in various bands, all specify "channel": "" which doesn't match the above definition.

Maybe sending an empty value means "do not change current value". If this is case, IMHO, this should be added to the above definition.

 

For "radioEnable" setting, doc says "Enable/Disable radio setting(if false, other params is not required)". Shall we understand that if "radioEnable" is set to "true", all other settings are required.

 

An other point I'm having issue with is setting txPower. Do you have to provide both txPower and txPowerLevel ?

 

[1] https://use1-omada-northbound.tplinkcloud.com/doc.html#/00%20All/Ap/modifyRadiosConfig

 

Best regards

  0      
  0      
#1
Options
1 Accepted Solution
Re:OpenAPI doc improvement in radio setting-Solution
2025-05-28 09:05:29 - last edited 2025-05-28 09:05:33

Hi  @Oliv2831 

 

Thank you for your feedback. We will consider optimizing our API documentation. Regarding your question, the examples in the documentation primarily aim to demonstrate the mandatory parameters and required formats.

 

Do you have to provide both txPower and txPowerLevel ?

>>>Only if the txPowerLevel is custom will the txPower be required. Otherwise, you don't need to config txPower.

Recommended Solution
  0  
  0  
#2
Options
1 Reply
Re:OpenAPI doc improvement in radio setting-Solution
2025-05-28 09:05:29 - last edited 2025-05-28 09:05:33

Hi  @Oliv2831 

 

Thank you for your feedback. We will consider optimizing our API documentation. Regarding your question, the examples in the documentation primarily aim to demonstrate the mandatory parameters and required formats.

 

Do you have to provide both txPower and txPowerLevel ?

>>>Only if the txPowerLevel is custom will the txPower be required. Otherwise, you don't need to config txPower.

Recommended Solution
  0  
  0  
#2
Options