Jump to: navigation, search

Difference between revisions of "API Special Interest Group/Current Design/Version Responses"

(Current Design: add cinder examples)
(Current Design: add nova example)
Line 70: Line 70:
 
         "status": "CURRENT"
 
         "status": "CURRENT"
 
     }
 
     }
 +
}
 +
</nowiki></pre>
 +
 +
== Nova ==
 +
 +
[http://developer.openstack.org/api-ref-compute-v2.1.html Nova API reference]
 +
 +
=== Examples ===
 +
 +
<pre><nowiki>GET /</nowiki></pre>
 +
 +
<pre><nowiki>
 +
{
 +
    "versions": [
 +
        {
 +
            "id": "v2.0",
 +
            "links": [
 +
                {
 +
                    "href": "http://openstack.example.com/v2/",
 +
                    "rel": "self"
 +
                }
 +
            ],
 +
            "status": "SUPPORTED",
 +
            "version": "",
 +
            "min_version": "",
 +
            "updated": "2011-01-21T11:33:21Z"
 +
        },
 +
        {
 +
            "id": "v2.1",
 +
            "links": [
 +
                {
 +
                    "href": "http://openstack.example.com/v2.1/",
 +
                    "rel": "self"
 +
                }
 +
            ],
 +
            "status": "CURRENT",
 +
            "version": "2.12",
 +
            "min_version": "2.1",
 +
            "updated": "2013-07-23T11:33:21Z"
 +
        }
 +
    ]
 
}
 
}
 
</nowiki></pre>
 
</nowiki></pre>

Revision as of 21:28, 4 December 2015

Analysis

What responses are being returned for version requests?

This analysis is specifically asking for versions reported by an API server through a GET request at "/", "/version", "/v1", or similar.

The Version Discovery page on the OpenStack wiki is being used as a reference point in this analysis.

Current Design

Cinder

Cinder API reference

Examples

GET /
{
    "versions": [
        {
            "id": "v1.0",
            "links": [
                {
                    "href": "http://23.253.211.234:8776/v1/",
                    "rel": "self"
                }
            ],
            "status": "DEPRECATED",
            "updated": "2014-06-28T12:20:21Z"
        },
        {
            "id": "v2.0",
            "links": [
                {
                    "href": "http://23.253.211.234:8776/v2/",
                    "rel": "self"
                }
            ],
            "status": "CURRENT",
            "updated": "2012-11-21T11:33:21Z"
        }
    ]
}
GET /v2
{
    "version": {
        "id": "v2.0",
        "links": [
            {
                "href": "http://23.253.211.234:8776/v2/v2.0",
                "rel": "self"
            }
        ],
        "media-types": [
            {
                "base": "application/xml",
                "type": "application/vnd.openstack.volume+xml;version=1"
            },
            {
                "base": "application/json",
                "type": "application/vnd.openstack.volume+json;version=1"
            }
        ],
        "status": "CURRENT"
    }
}

Nova

Nova API reference

Examples

GET /
{
    "versions": [
        {
            "id": "v2.0",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED",
            "version": "",
            "min_version": "",
            "updated": "2011-01-21T11:33:21Z"
        },
        {
            "id": "v2.1",
            "links": [
                {
                    "href": "http://openstack.example.com/v2.1/",
                    "rel": "self"
                }
            ],
            "status": "CURRENT",
            "version": "2.12",
            "min_version": "2.1",
            "updated": "2013-07-23T11:33:21Z"
        }
    ]
}