missing parameter explaination in "Servers" section of v2.1 compute api

Bug #1572013 reported by Chengshuo
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Sharat Sharma

Bug Description

URL: http://developer.openstack.org/api-ref-compute-v2.1.html
I think the request parameters listed in "GET /v2.1/​{tenant_id}​/servers" of "Servers" section are not complete, when i want to get all servers of all tenants, there should be "?all_tenants=true" in the url, as i read in python-novaclient source code and it works actually after testing; but there is no specific description about "all_tenant" listed in "Request parameters" following in the api documentation.

Revision history for this message
Chengshuo (1324480595-2) wrote :
Chengshuo (1324480595-2)
description: updated
tags: added: servers-api-doc
description: updated
Revision history for this message
Atsushi SAKAI (sakaia) wrote :

Thank you for your reporting. Currently the nova issue for api-site is freezing state.


Changed in openstack-api-site:
assignee: nobody → Sharat Sharma (sharat-sharma)
Atsushi SAKAI (sakaia)
affects: openstack-api-site → nova
Revision history for this message
Matt Riedemann (mriedem) wrote :

This should be cleaned up as part of this blueprint in newton:


tags: added: api doc
tags: added: api-ref
Sean Dague (sdague)
tags: removed: api doc
Revision history for this message
Markus Zoeller (markus_z) (mzoeller) wrote :

I agree with Matt here, let's just close this bug report and use the
blueprint "api-ref-in-rst" to drive this. The effort is described on the
ML [1] and the wiki [2]. The file the bug reporter is referencing to
has a comment at the top which describes the needed cleanup tasks [3].

Long story short, push the patch you planned to do but reference the bp instead of the bug.

[1] [openstack-dev] [nova] api-ref content verification phase doc push
[2] https://wiki.openstack.org/wiki/NovaAPIRef#Parameter_Verification
[3] https://github.com/openstack/nova/blob/master/api-ref/source/servers.inc#L3

Changed in nova:
status: New → Opinion
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.