Chapter 3. API operations and extensions in OpenStack Networking API v2.0 (neutron) Reference - API v2.0 (neutron) and extensions

[cat lookabaugh]

The actual bug is in the Show Quotas operation. There is no request body and no id in the the URI, so how does the operation know which quota to show in the response?

Also, how do we report bugs from the api reference directly?
-----------------------------------
Built: 2014-08-19T20:45:49 00:00
git SHA: af5b833b4989a8728b25c29c76ec2d9ba06bc92f
URL: http://docs.openstack.org/api/openstack-network/2.0/content/API_Operations.html
source File: file:/home/jenkins/workspace/netconn-api-tox-doc-publishdocs/v2.0/neutron-api-guide.xml
xml:id: API_Operations

[Anne Gentle (annegentle)]

Hi Cat, there's no way to report a doc bug from the API Complete Reference like there is with the "classic" HTML output.

As for the Show Quotas operation, is it incorrect in the Complete Reference? If so I'll triage this bug accordingly. We're not planning further updates to the Dev Ref at docs.openstack.org/api/openstack-network/2.0/content/API_Operations.html due to the lack of complete parameter descriptions in that output.

[cat lookabaugh (cat-lookabaugh)]

Alas, the complete reference links all api operations to the api ref site. so there is just one source of truth, and the api-ref (underlying wadl) need to be updated, i think.

[Jamie Hannaford (jamie-hannaford)]

I'm also running into this issue. The developer.openstack.org complete reference only lists three operations for quota

1. Get a quote (GET /v2.0/quotas) - but the documented response is wrong. This path actually returns a COLLECTION of quotas, not a single object

2. Update a quota (PUT /v2.0/quotas) - which returns a 404, because the tenant_id is missing in the path

3. Reset a quota (DELETE /v2.0/quotas) - same as update

LIST quotas and CREATE quota are not documented. I'm also unsure as to the role of tenant_id in these operations, I can't find it documented anywhere.

[Launchpad Janitor (janitor)]

[Expired for openstack-api-site because there has been no activity for 60 days.]

[Anne Gentle (annegentle)]

Looks like Jamie's findings need to be documented in the Networking API WADL.

[Atsushi SAKAI (sakaia)]

Let me clearify this issue. it seems following information need to be added by #3 description
Am I correct?

1)　get /v2.0/quotas List Quotas
 http://developer.openstack.org/api-ref-networking-v2-ext.html#listQuotas

   it seems just add correct sample

2)put /v2.0/quotas/​{tenant_id} Update Quota
  ​http://developer.openstack.org/api-ref-networking-v2-ext.html#updateQuota

  it just needs to add 404 description

3)delete /v2.0/quotas/{tenant_id} Reset Quota
  http://developer.openstack.org/api-ref-networking-v2-ext.html#resetQuota

  it just needs to add 404 description

[cat lookabaugh (cat-lookabaugh)]

Looks good!

-- Cat Lookabaugh, Sr. Information Developer
Rackspace Hosting – the #1 Managed Cloud Company
DevDocs on Developer Experience Team

Office: [phone] Cell: [phone]
<email address hidden>

We should not write so that it is possible for the reader to understand
us, but so that it is impossible for him to misunderstand us. -
Quintilian, rhetorician (c. 35-100)

Harmony + Learner + Responsibility + Context + Intellection + Arranger +
Consistency + Relator + Input + Analytical

On 7/29/15 3:59 AM, "<email address hidden> on behalf of Atsushi SAKAI"
<<email address hidden> on behalf of <email address hidden>> wrote:

>Let me clearify this issue. it seems following information need to be
>added by #3 description
>Am I correct?
>
>1)　get /v2.0/quotas List Quotas
>　http://developer.openstack.org/api-ref-networking-v2-ext.html#listQuotas
>
> it seems just add correct sample
>
>2)put /v2.0/quotas/​{tenant_id} Update Quota
>
>​http://developer.openstack.org/api-ref-networking-v2-ext.html#updateQuota
>
> it just needs to add 404 description
>
>3)delete /v2.0/quotas/{tenant_id} Reset Quota
> http://developer.openstack.org/api-ref-networking-v2-ext.html#resetQuota
>
> it just needs to add 404 description
>
>--
>You received this bug notification because you are subscribed to the bug
>report.
>https://bugs.launchpad.net/bugs/1365601
>
>Title:
> Chapter 3. API operations and extensions in OpenStack Networking API
> v2.0 (neutron) Reference - API v2.0 (neutron) and extensions
>
>Status in openstack-api-site:
> Confirmed
>
>Bug description:
> The actual bug is in the Show Quotas operation. There is no request
> body and no id in the the URI, so how does the operation know which
> quota to show in the response?
>
> Also, how do we report bugs from the api reference directly?
> -----------------------------------
> Built: 2014-08-19T20:45:49 00:00
> git SHA: af5b833b4989a8728b25c29c76ec2d9ba06bc92f
> URL:
>http://docs.openstack.org/api/openstack-network/2.0/content/API_Operations
>.html
> source File:
>file:/home/jenkins/workspace/netconn-api-tox-doc-publishdocs/v2.0/neutron-
>api-guide.xml
> xml:id: API_Operations
>
>To manage notifications about this bug go to:
>https://bugs.launchpad.net/openstack-api-site/+bug/1365601/+subscriptions

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/208465

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/208465
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=533196b36b70bb7c4464a8d92a991d1b3caab833
Submitter: Jenkins
Branch: master

commit 533196b36b70bb7c4464a8d92a991d1b3caab833
Author: Atsushi SAKAI <email address hidden>
Date: Mon Aug 3 21:21:29 2015 +0900

    Update Neutron quota description

    Update "List quotas" example
    Add 404 code to Show/Update/Reset quota

    Change-Id: I10917965d1c0413f9afa9d4f2189ee62e2a1d947
    Closes-Bug: #1365601