yahoo-eng-team team mailing list archive

[Matt Riedemann <mriedem.os@xxxxxxxxx>]

Public bug reported:

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";
            }
        ]
    }
}

** Affects: nova
     Importance: High
         Status: Confirmed


** Tags: api docs low-hanging-fruit

** Tags removed: low-h
** Tags added: low-hanging-fruit

-- 
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):
  Confirmed

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