yahoo-eng-team team mailing list archive

[Matt Riedemann <mriedem.os@xxxxxxxxx>]

Public bug reported:

- [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

** Affects: nova
     Importance: Medium
     Assignee: Matt Riedemann (mriedem)
         Status: Triaged


** Tags: api-guide doc

** Changed in: nova
     Assignee: (unassigned) => Matt Riedemann (mriedem)

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1762842

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

Status in OpenStack Compute (nova):
  Triaged

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

To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1762842/+subscriptions