As a result of time spent within stx-fault, there are API reference content
gaps:
- "The API document should be modified to match the description returned from
API query": changed both the name of the desciption.
- "Wrong "links" reference: changed to existing StarlingX stx-fault API
reference.
- Additional: Remove <U+200B> character.
More Information:
- [Starlingx-discuss] API requests: stx-fault [0]
- Etherpad StarlingX APIs Review [1]
[0] http://lists.starlingx.io/pipermail/starlingx-discuss/2018-December/002150.html
[1] https://etherpad.openstack.org/p/stx-apis
Story: 2004877
Task: 29153
Change-Id: Ifb3da9492b74b4ecf7be265294af5d2e604d56e5
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
Include the optional “expand” option to the get list for alarms and
events so the entire set of data can be returned and not just a
subset. “expand” is and optional parameter and defaults to False.
Story: 2004818
Task: 29096
Change-Id: Ife3b900d90c56564e9aeaa820e57f69d15194eb3
Signed-off-by: Kristine Bujold <kristine.bujold@windriver.com>
I added the api-ref-fm-v1-fault.rst file, which is content for
the API reference manual to the api-ref/source dir. This
represents the converted old-style files to the newer OpenStack
supported RST files.
I updated the index.rst file to include the new .rst file so
that the api-ref document can build.
Added details for "Shows details for Fault Management API v1"
Change-Id: Ie0daae5b4ddc6c6363f647b15c507b664635b2d3
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
