Compute API guide: Faults in nova - Instance Faults section is wrong

Bug #1762842 reported by Matt Riedemann
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Medium
Matt Riedemann

Bug Description

- [x] This doc is inaccurate in this way:

This section about instance faults:

https://developer.openstack.org/api-guide/compute/faults.html#instance-faults

says:

"However, there is currently no API to retrieve this information."

This is wrong, as the GET /servers/{server_id} response has a 'fault' entry if there was a fault for the server:

https://developer.openstack.org/api-ref/compute/#id27

"A fault object. Only displayed in the failed response. Default keys are code, created, and message (response code, created time, and message respectively). In addition, the key details (stack trace) is available if you have the administrator privilege."

-----------------------------------
Release: 17.0.0.0rc2.dev613 on 2018-04-10 15:08
SHA: 836c3913cc382428625a5e7502a4c807b8136d0a
Source: https://git.openstack.org/cgit/openstack/nova/tree/api-guide/source/faults.rst
URL: https://developer.openstack.org/api-guide/compute/faults.html

Tags: doc api-guide
Matt Riedemann (mriedem)
Changed in nova:
assignee: nobody → Matt Riedemann (mriedem)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

Fix proposed to branch: master
Review: https://review.openstack.org/560178

Changed in nova:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

Reviewed: https://review.openstack.org/560178
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=88f86e24e121ba545012051b6587d7475bfc5cec
Submitter: Zuul
Branch: master

commit 88f86e24e121ba545012051b6587d7475bfc5cec
Author: Matt Riedemann <email address hidden>
Date: Tue Apr 10 19:30:51 2018 -0400

    doc: cleanup API guide about instance faults

    The compute API guide section on instance faults
    is updated to point out that server details contain
    fault information for servers in ERROR or DELETED status
    along with a simple non-admin scenario example.

    Change-Id: Idc725a594b67b5f6e45c6f161f6e92c0601761a8
    Closes-Bug: #1762842

Changed in nova:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/nova 18.0.0.0b2

This issue was fixed in the openstack/nova 18.0.0.0b2 development milestone.

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

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.