Wrong content in "paginated collections" API guide page

Bug #1737854 reported by Matt Riedemann
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
High
Ghanshyam Mann

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

Matt Riedemann (mriedem)
tags: added: low-hanging-fruit
removed: low-h
Chason Chan (chen-xing)
Changed in nova:
assignee: nobody → Chason Chan (chen-xing)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

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

Changed in nova:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

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

commit fbba1d17a4b19c7f9e1bcc3a42621149a5e3be0d
Author: chenxing <email address hidden>
Date: Wed Dec 13 18:00:28 2017 +0800

    Fix the bug report link of API Guide

    Currently, it redirects back to the same page.

    Change-Id: Ia855ad2cfa1fdc42bffac07812799b032a0cc7ce
    Partial-Bug: #1737854

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

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

do3meli (d-info-e)
tags: added: doc
removed: docs
Changed in nova:
assignee: Chason Chan (chen-xing) → Ghanshyam Mann (ghanshyammann)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

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 <email address hidden>
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
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/nova 18.0.0.0rc1

This issue was fixed in the openstack/nova 18.0.0.0rc1 release candidate.

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.