← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1737854] Re: Wrong content in "paginated collections" API guide page

 

Reviewed:  https://review.openstack.org/528180
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=22ab1b62b311f238e91c48253b2c8fa9ad9fa328
Submitter: Zuul
Branch:    master

commit 22ab1b62b311f238e91c48253b2c8fa9ad9fa328
Author: chenxing <chason.chan@xxxxxxxxxxx>
Date:   Fri Dec 15 15:23:09 2017 +0800

    Fix the incorrect description and sample
    
    This patch fixes the following:
     * The description says, "Here, a subset of metadata items
       are presented within the image." This is a server sample,
       not an image.
    
     * The sample itself has the wrong id in the "self" link and
       there are no metadata_links with a server object (probably
       a carry over from an image docs sample).
    
    Change-Id: Idb1e5243d6d072e020e1532bec603e5cd219702e
    Closes-Bug: #1737854


** Changed in: nova
       Status: In Progress => Fix Released

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1737854

Title:
  Wrong content in "paginated collections" API guide page

Status in OpenStack Compute (nova):
  Fix Released

Bug description:
  There are a few issues in this doc:

  https://developer.openstack.org/api-
  guide/compute/paginated_collections.html

  1. The bug link doesn't work, it redirects back to the same page (not
  sure why).

  2. The description of the example says:

  "The following examples illustrate three pages in a collection of
  images."

  But it's clearly showing examples of paging through servers, not
  images (likely this doc was copied from some glance docs and not fully
  updated).

  3. The sample at the bottom has a few issues:

  a) The description says, "Here, a subset of metadata items are
  presented within the image." - again, this is a server sample, not an
  image.

  b) The sample itself has the (1) wrong id in the "self" link and (2)
  there are no metadata_links with a server object (again, probably a
  carry over from an image docs sample).

  {
      "server": {
          "id": "52415800-8b69-11e0-9b19-734f6f006e54",
          "name": "Elastic",
          "metadata": {
              "Version": "1.3",
              "ServiceType": "Bronze"
          },
          "metadata_links": [
              {
                  "rel": "next",
                  "href": "https://servers.api.openstack.org/v2.1/servers/fc55acf4-3398-447b-8ef9-72a42086d775/meta?marker=ServiceType";
              }
          ],
          "links": [
              {
                  "rel": "self",
                  "href": "https://servers.api.openstack.org/v2.1/servers/fc55acf4-3398-447b-8ef9-72a42086d775";
              }
          ]
      }
  }

To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1737854/+subscriptions


References