wrong doc for disabaled_reason in service list

Bug #1328382 reported by jiang, yunhong
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Low
jiang, yunhong

Bug Description

In http://developer.openstack.org/api-ref-compute-v2-ext.html, the 'disabled_reason" field will be None for xml format and 'null’ for json format. However, in the documentation, it's stated as "", which is not correct.

Below is the output of nova client:

yjiang5@otccloud06:/opt/stack/nova$ nova --debug service-list

..................

RESP BODY: {"services": [{"status": "enabled", "binary": "nova-conductor", "zone": "internal", "state": "up", "updated_at": "2014-06-10T05:28:39.000000", "host": "otccloud06", "disabled_reason": null, "id": 1}, {"status": "enabled", "binary": "nova-compute", "zone": "nova", "state": "up", "updated_at": "2014-06-10T05:28:48.000000", "host": "otccloud06", "disabled_reason": null, "id": 2}, {"status": "enabled", "binary": "nova-cert", "zone": "internal", "state": "up", "updated_at": "2014-06-10T05:28:46.000000", "host": "otccloud06", "disabled_reason": null, "id": 3}, {"status": "enabled", "binary": "nova-network", "zone": "internal", "state": "up", "updated_at": "2014-06-10T05:28:48.000000", "host": "otccloud06", "disabled_reason": null, "id": 4}, {"status": "enabled", "binary": "nova-scheduler", "zone": "internal", "state": "up", "updated_at": "2014-06-10T05:28:48.000000", "host": "otccloud06", "disabled_reason": null, "id": 5}, {"status": "enabled", "binary": "nova-consoleauth", "zone": "internal", "state": "up", "updated_at": "2014-06-10T05:28:44.000000", "host": "otccloud06", "disabled_reason": null, "id": 6}]}

Tags: api
Changed in nova:
assignee: nobody → jiang, yunhong (yunhong-jiang)
milestone: none → juno-1
tags: added: api
Changed in nova:
importance: Undecided → Low
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/98954

Revision history for this message
John Garbutt (johngarbutt) wrote :

We use milestones only at the very end of the milestone to track bugs that should block the release of the milestone. Please use tags not milestones to track bugs, try things like: my_bug_topic_milestone_name

Changed in nova:
milestone: juno-1 → none
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

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

commit df60f2cd334b6f9418f2a21d80f8a8a69592d9fa
Author: Yunhong Jiang <email address hidden>
Date: Mon Jun 9 22:30:56 2014 -0700

    Fix doc for service list

    If a service is enabled, the "disabled_reason" field in response
    for /v2/.{tenant_id}./os-services/detail is null, however, currently
    it's specified as "" in the doc, thus may be confusing to users.

    This patch change the template and doc, it should not cause issue to
    existing applications.

    Change-Id: Ia71ec4c97a355bcc1a7b63e6107db77f80a5d843
    Close-bug: 1328382

Changed in nova:
status: New → Fix Committed
Changed in nova:
milestone: none → juno-2
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in nova:
milestone: juno-2 → 2014.2
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.