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

Bug #1572013 reported by Chengshuo on 2016-04-19
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Undecided
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.

Chengshuo (1324480595-2) wrote :
Chengshuo (1324480595-2) on 2016-04-19
description: updated
tags: added: servers-api-doc
description: updated
Atsushi SAKAI (sakaia) wrote :

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

Ref.
http://lists.openstack.org/pipermail/openstack-docs/2016-April/008453.html

Changed in openstack-api-site:
assignee: nobody → Sharat Sharma (sharat-sharma)
Atsushi SAKAI (sakaia) on 2016-04-21
affects: openstack-api-site → nova
Matt Riedemann (mriedem) wrote :

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

https://blueprints.launchpad.net/nova/+spec/api-ref-in-rst

tags: added: api doc
tags: added: api-ref
Sean Dague (sdague) on 2016-04-22
tags: removed: api doc

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.

References:
[1] [openstack-dev] [nova] api-ref content verification phase doc push
 http://lists.openstack.org/pipermail/openstack-dev/2016-April/092936.html
[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  Edit
Everyone can see this information.

Other bug subscribers