summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAbraham Arce <abraham.arce.moreno@intel.com>2019-01-28 07:40:36 -0600
committerAbraham Arce <abraham.arce.moreno@intel.com>2019-01-28 09:12:32 -0600
commitd911b3972aea8458f7dbc01daba88e80857d2b82 (patch)
treeccccf3841c584f43a949348867b619a04198b378
parent64939761628c1bf2b389877bfd1618f8d1dfba65 (diff)
[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 <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>
Notes
Notes (review): Code-Review+2: Tao Liu <tao.liu@windriver.com> Code-Review+2: Al Bailey <al.bailey@windriver.com> Workflow+1: Al Bailey <al.bailey@windriver.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Tue, 29 Jan 2019 20:30:33 +0000 Reviewed-on: https://review.openstack.org/633604 Project: openstack/stx-fault Branch: refs/heads/master
-rw-r--r--api-ref/source/api-ref-fm-v1-fault.rst14
1 files 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 a862895..f8284ad 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)
51 ] 51 ]
52 } 52 }
53 ], 53 ],
54 "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. ", 54 "description":"Fault Management is an OpenStack project which provides REST API services for alarms and logs.",
55 "name":"stx-fault API" 55 "name":"Fault Management API"
56 } 56 }
57 57
58This operation does not accept a request body. 58This operation does not accept a request body.
@@ -88,7 +88,7 @@ itemNotFound (404)
88 "rel": "self" 88 "rel": "self"
89 }, 89 },
90 { 90 {
91 "href": "http://www.windriver.com/developer/fm/dev/api-spec-v1.html", 91 "href": "https://docs.starlingx.io/api-ref/stx-fault/index.html",
92 "type": "text/html", 92 "type": "text/html",
93 "rel": "describedby" 93 "rel": "describedby"
94 } 94 }
@@ -211,7 +211,7 @@ itemNotFound (404)
211Shows information about a specific alarm 211Shows information about a specific alarm
212****************************************** 212******************************************
213 213
214.. rest_method:: GET /v1/alarms/{alarm_uuid} 214.. rest_method:: GET /v1/alarms/{alarm_uuid}
215 215
216**Normal response codes** 216**Normal response codes**
217 217
@@ -282,7 +282,7 @@ This operation does not accept a request body.
282Deletes a specific alarm 282Deletes a specific alarm
283************************** 283**************************
284 284
285.. rest_method:: DELETE /v1/alarms/{alarm_uuid} 285.. rest_method:: DELETE /v1/alarms/{alarm_uuid}
286 286
287NOTE Typically this command should NOT be used. I.e typically alarms 287NOTE Typically this command should NOT be used. I.e typically alarms
288will be and should be cleared by the system when the alarm condition 288will be and should be cleared by the system when the alarm condition
@@ -438,7 +438,7 @@ itemNotFound (404)
438Shows information about a specific event log 438Shows information about a specific event log
439********************************************** 439**********************************************
440 440
441.. rest_method:: GET /v1/event_log/{log_uuid} 441.. rest_method:: GET /v1/event_log/{log_uuid}
442 442
443**Normal response codes** 443**Normal response codes**
444 444
@@ -602,7 +602,7 @@ This operation does not accept a request body.
602Modifies the value of an event suppression 602Modifies the value of an event suppression
603******************************************** 603********************************************
604 604
605.. rest_method:: PATCH /v1/event_suppression/{event_suppression_uuid} 605.. rest_method:: PATCH /v1/event_suppression/{event_suppression_uuid}
606 606
607**Normal response codes** 607**Normal response codes**
608 608