Versions in OpenStack Identity API v2.0 Reference  - API v2.0 and extensions

Bug #1338120 reported by Brant Knudson
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-api-site
Fix Released
Medium
Diane Fleming

Bug Description

The examples should be updated with Keystone's current response.

Example 1.18. List versions: JSON response

should be

{
    "versions": {
        "values": [
            {
                "id": "v3.0",
                "links": [
                    {
                        "href": "http://192.168.122.176:5000/v3/",
                        "rel": "self"
                    }
                ],
                "media-types": [
                    {
                        "base": "application/json",
                        "type": "application/vnd.openstack.identity-v3+json"
                    },
                    {
                        "base": "application/xml",
                        "type": "application/vnd.openstack.identity-v3+xml"
                    }
                ],
                "status": "stable",
                "updated": "2013-03-06T00:00:00Z"
            },
            {
                "id": "v2.0",
                "links": [
                    {
                        "href": "http://192.168.122.176:5000/v2.0/",
                        "rel": "self"
                    },
                    {
                        "href": "http://docs.openstack.org/",
                        "rel": "describedby",
                        "type": "text/html"
                    }
                ],
                "media-types": [
                    {
                        "base": "application/json",
                        "type": "application/vnd.openstack.identity-v2.0+json"
                    },
                    {
                        "base": "application/xml",
                        "type": "application/vnd.openstack.identity-v2.0+xml"
                    }
                ],
                "status": "stable",
                "updated": "2014-04-17T00:00:00Z"
            }
        ]
    }
}

Example 1.16. List versions: XML response

should be:

<?xml version="1.0" encoding="UTF-8"?>
<versions xmlns="http://docs.openstack.org/identity/api/v2.0">
  <version status="stable" updated="2013-03-06T00:00:00Z" id="v3.0">
    <media-types>
      <media-type base="application/json" type="application/vnd.openstack.identity-v3+json"/>
      <media-type base="application/xml" type="application/vnd.openstack.identity-v3+xml"/>
    </media-types>
    <links>
      <link href="http://192.168.122.176:5000/v3/" rel="self"/>
    </links>
  </version>
  <version status="stable" updated="2014-04-17T00:00:00Z" id="v2.0">
    <media-types>
      <media-type base="application/json" type="application/vnd.openstack.identity-v2.0+json"/>
      <media-type base="application/xml" type="application/vnd.openstack.identity-v2.0+xml"/>
    </media-types>
    <links>
      <link href="http://192.168.122.176:5000/v2.0/" rel="self"/>
      <link href="http://docs.openstack.org/" type="text/html" rel="describedby"/>
    </links>
    <link href="http://192.168.122.176:5000/v2.0/" rel="self"/>
    <link href="http://docs.openstack.org/" type="text/html" rel="describedby"/>
  </version>
</versions>

Example 1.17. List versions: Atom response

should be removed. Keystone doesn't provide an Atom response to GET /

-----------------------------------
Built: 2014-07-05T14:25:04 00:00
git SHA: d92c5799553bee3fa2327a2233bff7578a760104
URL: http://docs.openstack.org/api/openstack-identity-service/2.0/content/Versions-d1e472.html
source File: file:/home/jenkins/workspace/identity-api-tox-doc-publishdocs/v2.0/src/ch_identity-general-api-info.xml
xml:id: Versions-d1e472

affects: openstack-manuals → openstack-api-site
Changed in openstack-api-site:
status: New → Confirmed
importance: Undecided → Medium
assignee: nobody → Diane Fleming (diane-fleming)
milestone: none → juno
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to api-site (master)

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

Changed in openstack-api-site:
status: Confirmed → In Progress
Changed in openstack-manuals:
status: New → In Progress
importance: Undecided → Medium
assignee: nobody → Diane Fleming (diane-fleming)
milestone: none → juno
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to identity-api (master)

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

Revision history for this message
Diane Fleming (diane-fleming) wrote :

Identity API v2.0 Reference: https://review.openstack.org/110777

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to api-site (master)

Reviewed: https://review.openstack.org/110768
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=2517c76748eb553129f81f6600d9ff60301bd27e
Submitter: Jenkins
Branch: master

commit 2517c76748eb553129f81f6600d9ff60301bd27e
Author: Diane Fleming <email address hidden>
Date: Wed Jul 30 15:05:36 2014 -0500

    Update list versions responses (JSON and XML)

    Change-Id: Ifc7abb812a3e87feaeddcc1383ef1bff1286078a
    Partial-Bug: #1338120

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to identity-api (master)

Reviewed: https://review.openstack.org/110777
Committed: https://git.openstack.org/cgit/openstack/identity-api/commit/?id=a47eba6e4c30407cf9f491f477b20c05e2392b04
Submitter: Jenkins
Branch: master

commit a47eba6e4c30407cf9f491f477b20c05e2392b04
Author: Diane Fleming <email address hidden>
Date: Wed Jul 30 15:33:54 2014 -0500

    Remove ATOM responses for list versions and get version details.

    Once https://review.openstack.org/#/c/110768/ merges,
    the JSON and XML list versions responses will update.
    Also, other clean-up (formatting, future tense)

    Change-Id: If9248bdd9e73ccc7ac7871aa8981925eb5a889d4
    Closes-Bug: #1338120

Changed in openstack-api-site:
status: In Progress → Fix Released
Tom Fifield (fifieldt)
no longer affects: openstack-manuals
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.