From d911b3972aea8458f7dbc01daba88e80857d2b82 Mon Sep 17 00:00:00 2001 From: Abraham Arce Date: Mon, 28 Jan 2019 07:40:36 -0600 Subject: [PATCH] [Doc] API Content Gaps 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 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 --- api-ref/source/api-ref-fm-v1-fault.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/api-ref/source/api-ref-fm-v1-fault.rst b/api-ref/source/api-ref-fm-v1-fault.rst index a8628953..f8284ade 100644 --- a/api-ref/source/api-ref-fm-v1-fault.rst +++ b/api-ref/source/api-ref-fm-v1-fault.rst @@ -51,8 +51,8 @@ itemNotFound (404) ] } ], - "description":"StarlingX Fault API allows for the management of physical servers. This includes inventory collection and configuration of hosts, ports, interfaces, CPUs, disk, memory, and system configuration. The API also supports the configuration of the cloud's SNMP interface. ", - "name":"stx-fault API" + "description":"Fault Management is an OpenStack project which provides REST API services for alarms and logs.", + "name":"Fault Management API" } This operation does not accept a request body. @@ -88,7 +88,7 @@ itemNotFound (404) "rel": "self" }, { - "href": "http://www.windriver.com/developer/fm/dev/api-spec-v1.html", + "href": "https://docs.starlingx.io/api-ref/stx-fault/index.html", "type": "text/html", "rel": "describedby" } @@ -211,7 +211,7 @@ itemNotFound (404) Shows information about a specific alarm ****************************************** -.. rest_method:: GET /v1/alarms/​{alarm_uuid}​ +.. rest_method:: GET /v1/alarms/{alarm_uuid} **Normal response codes** @@ -282,7 +282,7 @@ This operation does not accept a request body. Deletes a specific alarm ************************** -.. rest_method:: DELETE /v1/alarms/​{alarm_uuid}​ +.. rest_method:: DELETE /v1/alarms/{alarm_uuid} NOTE Typically this command should NOT be used. I.e typically alarms will be and should be cleared by the system when the alarm condition @@ -438,7 +438,7 @@ itemNotFound (404) Shows information about a specific event log ********************************************** -.. rest_method:: GET /v1/event_log/​{log_uuid}​ +.. rest_method:: GET /v1/event_log/{log_uuid} **Normal response codes** @@ -602,7 +602,7 @@ This operation does not accept a request body. Modifies the value of an event suppression ******************************************** -.. rest_method:: PATCH /v1/event_suppression/​{event_suppression_uuid}​ +.. rest_method:: PATCH /v1/event_suppression/{event_suppression_uuid} **Normal response codes**