Missing API doc for fault server field

Bug #1545972 reported by Oliver Gondza
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Undecided
Sharat Sharma
openstack-api-site
Invalid
Undecided
Pallavi

Bug Description

In API reference[1], optional response field `fault` is not mentioned under `GET /v2/XXX/servers/YYY`.

[1] http://developer.openstack.org/api-ref-compute-v2.1.html

Revision history for this message
Atsushi SAKAI (sakaia) wrote :
tags: added: nova
Atsushi SAKAI (sakaia)
Changed in openstack-api-site:
status: New → Confirmed
Pallavi (pallavi-s)
Changed in openstack-api-site:
assignee: nobody → Pallavi (pallavi-s)
Revision history for this message
Oliver Gondza (ogondza) wrote :

> You are pointing following URL?
> http://developer.openstack.org/api-ref-compute-v2.1.html#showServer

That is the one.

Revision history for this message
Pallavi (pallavi-s) wrote :

Are you talking about table or the JSON format. If you are talking about JSON format. The fault will not be there for success response. The fault field will be there in the failed response.

Revision history for this message
Oliver Gondza (ogondza) wrote :

I presume the json excerpt is an example but I am talking about the table. I says nothing about the `fault` field much less about "The fault will not be there for success response. The fault field will be there in the failed response.". It would be great to have this in the documentation.

Revision history for this message
Sharat Sharma (sharat-sharma) wrote :

Confirmed in the api-site, so pushing a patch.

Changed in nova:
assignee: nobody → Sharat Sharma (sharat-sharma)
status: New → In Progress
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/310429

Changed in openstack-api-site:
status: Confirmed → Invalid
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

Reviewed: https://review.openstack.org/310429
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=54dfffb842500d4b77b5d44d0ef787f012d084ed
Submitter: Jenkins
Branch: master

commit 54dfffb842500d4b77b5d44d0ef787f012d084ed
Author: sharat.sharma <email address hidden>
Date: Wed Apr 27 17:39:24 2016 +0530

    Added fault response parameter to Show Server Details API.

    The Show Server Details returns fault field in the failed
    responses. This patch adds the fault field to the response
    parameter table.

    Change-Id: I413a098061eb58ba70b3a18d646398dfdac590aa
    Closes-Bug: #1545972

Changed in nova:
status: In Progress → Fix Released
Revision history for this message
Davanum Srinivas (DIMS) (dims-v) wrote : Fix included in openstack/nova 14.0.0.0b1

This issue was fixed in the openstack/nova 14.0.0.0b1 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.