The documented StarlingX REST API to add a subcloud is incorrect

Bug #1856728 reported by Tee Ngo on 2019-12-17
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
StarlingX
Medium
Dariush Eslimi

Bug Description

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) wrote :

stx.4.0 / medium priority - doc update

tags: added: stx.distcloud stx.docs
Changed in starlingx:
importance: Undecided → Medium
status: New → Triaged
tags: added: stx.4.0
Changed in starlingx:
assignee: nobody → Dariush Eslimi (deslimi)
Kristal Dale (kdale) wrote :

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

To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers