Browse Source

[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>
Abraham Arce 2 months ago
parent
commit
d911b3972a
1 changed files with 7 additions and 7 deletions
  1. 7
    7
      api-ref/source/api-ref-fm-v1-fault.rst

+ 7
- 7
api-ref/source/api-ref-fm-v1-fault.rst View File

@@ -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. ",
55
-      "name":"stx-fault API"
54
+      "description":"Fault Management is an OpenStack project which provides REST API services for alarms and logs.",
55
+      "name":"Fault Management API"
56 56
    }
57 57
 
58 58
 This operation does not accept a request body.
@@ -88,7 +88,7 @@ itemNotFound (404)
88 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 92
                "type": "text/html",
93 93
                "rel": "describedby"
94 94
            }
@@ -211,7 +211,7 @@ itemNotFound (404)
211 211
 Shows 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 216
 **Normal response codes**
217 217
 
@@ -282,7 +282,7 @@ This operation does not accept a request body.
282 282
 Deletes 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
 
287 287
 NOTE Typically this command should NOT be used. I.e typically alarms
288 288
 will be and should be cleared by the system when the alarm condition
@@ -438,7 +438,7 @@ itemNotFound (404)
438 438
 Shows 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 443
 **Normal response codes**
444 444
 
@@ -602,7 +602,7 @@ This operation does not accept a request body.
602 602
 Modifies 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 607
 **Normal response codes**
608 608
 

Loading…
Cancel
Save