The documented StarlingX REST API to add a subcloud is incorrect

[Tee Ngo]

Brief Description
-----------------
StarlingX REST API documented here: https://docs.starlingx.io/api-ref/distcloud/api-ref-dcmanager-v1.html?expanded=creates-a-subcloud-detail#subclouds is incorrect.

Severity
--------
Major - this REST API is unusable the way it is documented.

Steps to Reproduce
------------------
Send an add subcloud POST request with the payload as documented.

Expected Behavior
------------------
Request is accepted and subcloud created.

Actual Behavior
----------------
Request is rejected due to incorrect parameters and missing parameters.
Incorrect parameters: management-start-ip (should be management_start_address), management-end-ip (should be management_end_address), management-subnet (should be management_subnet), management-gateway-ip (should be management_gateway_address), systemcontroller-gateway-ip (should be systemcontroller_gateway_address)

Missing parameters: system_mode, external_oam_subnet, external_oam_gateway_address, external_oam_floating_address, subcloud_password, bootstrap-address

Reproducibility
---------------
100% reproducible

System Configuration
--------------------
Distributed Cloud System Controller

Branch/Pull Time/Commit
-----------------------
Dec. 12th master load

Last Pass
---------
It appears that the documentation of this REST API is incorrect from day 1

Timestamp/Logs
--------------
N/A

Test Activity
-------------
Developer Test

[Ghada Khalil (gkhalil)]

stx.4.0 / medium priority - doc update

[Kristal Dale (kdale)]

Dariush - please let me know if I can assist with getting this update applied to the documentation. If you can provide the needed update (text, plus where it should be added), I can apply it and create a review.

Thanks!
Kris

[Dariush Eslimi (deslimi)]

Tao, please use this LP to update REST API after you make the changes for : https://bugs.launchpad.net/starlingx/+bug/1864508

[Tao Liu (tliu88)]

The REST API has been updated as part of fix to https://bugs.launchpad.net/starlingx/+bug/1864508:
https://opendev.org/starlingx/distcloud/src/branch/master/api-ref/source/api-ref-dcmanager-v1.rst

[Tao Liu (tliu88)]

The REST API was updated by commit:
https://opendev.org/starlingx/distcloud/commit/58a7186beae7b10866aecd53fcde5be34321a52c