From 7957b910dd5f9fede7268294558ceb32c9db77a2 Mon Sep 17 00:00:00 2001 From: Ken'ichi Ohmichi Date: Tue, 16 Aug 2016 16:17:03 -0700 Subject: [PATCH] Change api-site to v2.1 format The endpoint of v2.1 API is CURRENT now. On v2.1 API, a tenant-id is not necessary to be specified on the URL, that is good for making API calls simple for users. In addition, the endpoint is different from old v2.0 API. Then this patch makes the api-site fit for v2.1 format. Partially implements blueprint api-ref-in-rst Change-Id: I99224dfa77d64f7800733c1af69a55b3b5c761ac --- api-guide/source/limits.rst | 2 +- api-guide/source/links_and_references.rst | 8 ++++---- api-guide/source/paginated_collections.rst | 12 ++++++------ api-guide/source/polling_changes-since_parameter.rst | 2 +- api-guide/source/request_and_response_formats.rst | 2 +- 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/api-guide/source/limits.rst b/api-guide/source/limits.rst index 6fb14baae053..f46e58df4b7f 100644 --- a/api-guide/source/limits.rst +++ b/api-guide/source/limits.rst @@ -25,7 +25,7 @@ applications. The regular expression boundary matcher "^" for the rate limit takes effect after the root URI path. For example, the regular expression ^/servers would match the bolded portion of the following URI: -https://servers.api.openstack.org/v2/3542812\ **/servers**. +https://servers.api.openstack.org/v2.1\ **/servers**. **Table: Sample rate limits** diff --git a/api-guide/source/links_and_references.rst b/api-guide/source/links_and_references.rst index 1e57b7dda5cc..37adeac3171c 100644 --- a/api-guide/source/links_and_references.rst +++ b/api-guide/source/links_and_references.rst @@ -86,11 +86,11 @@ following types of link relations are associated with resources: "links":[ { "rel":"self", - "href":"http://servers.api.openstack.org/v2/1234/servers/52415800-8b69-11e0-9b19-734fcece0043" + "href":"http://servers.api.openstack.org/v2.1/servers/52415800-8b69-11e0-9b19-734fcece0043" }, { "rel":"bookmark", - "href":"http://servers.api.openstack.org/1234/servers/52415800-8b69-11e0-9b19-734fcece0043" + "href":"http://servers.api.openstack.org/servers/52415800-8b69-11e0-9b19-734fcece0043" } ] } @@ -108,11 +108,11 @@ following types of link relations are associated with resources: "links": [ { "rel" : "self", - "href" : "http://servers.api.openstack.org/v2/1234/images/52415800-8b69-11e0-9b19-734f5736d2a2" + "href" : "http://servers.api.openstack.org/v2.1/images/52415800-8b69-11e0-9b19-734f5736d2a2" }, { "rel" : "bookmark", - "href" : "http://servers.api.openstack.org/1234/images/52415800-8b69-11e0-9b19-734f5736d2a2" + "href" : "http://servers.api.openstack.org/images/52415800-8b69-11e0-9b19-734f5736d2a2" }, { "rel" : "alternate", diff --git a/api-guide/source/paginated_collections.rst b/api-guide/source/paginated_collections.rst index f3c2c78a2d04..f1945ee9e591 100644 --- a/api-guide/source/paginated_collections.rst +++ b/api-guide/source/paginated_collections.rst @@ -25,7 +25,7 @@ implementation does not contain ``previous`` links. The last page in the list does not contain a link to "next" page. The following examples illustrate three pages in a collection of images. The first page was retrieved through a **GET** to -``http://servers.api.openstack.org/v2/1234/servers?limit=1``. In these +``http://servers.api.openstack.org/v2.1/servers?limit=1``. In these examples, the *``limit``* parameter sets the page size to a single item. Subsequent links honor the initial page size. Thus, a client can follow links to traverse a paginated collection without having to input the @@ -39,7 +39,7 @@ links to traverse a paginated collection without having to input the { "servers_links":[ { - "href":"https://servers.api.openstack.org/v2/1234/servers?limit=1&marker=fc45ace4-3398-447b-8ef9-72a22086d775", + "href":"https://servers.api.openstack.org/v2.1/servers?limit=1&marker=fc45ace4-3398-447b-8ef9-72a22086d775", "rel":"next" } ], @@ -48,11 +48,11 @@ links to traverse a paginated collection without having to input the "id":"fc55acf4-3398-447b-8ef9-72a42086d775", "links":[ { - "href":"https://servers.api.openstack.org/v2/1234/servers/fc45ace4-3398-447b-8ef9-72a22086d775", + "href":"https://servers.api.openstack.org/v2.1/servers/fc45ace4-3398-447b-8ef9-72a22086d775", "rel":"self" }, { - "href":"https://servers.api.openstack.org/v2/1234/servers/fc45ace4-3398-447b-8ef9-72a22086d775", + "href":"https://servers.api.openstack.org/v2.1/servers/fc45ace4-3398-447b-8ef9-72a22086d775", "rel":"bookmark" } ], @@ -91,13 +91,13 @@ keep following the ``next`` link to retrieve the full set of metadata. "metadata_links": [ { "rel": "next", - "href": "https://servers.api.openstack.org/v2/1234/servers/fc55acf4-3398-447b-8ef9-72a42086d775/meta?marker=ServiceType" + "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/1234/servers/fc55acf4-3398-447b-8ef9-72a42086d775" + "href": "https://servers.api.openstack.org/v2.1/servers/fc55acf4-3398-447b-8ef9-72a42086d775" } ] } diff --git a/api-guide/source/polling_changes-since_parameter.rst b/api-guide/source/polling_changes-since_parameter.rst index 7354ccf22f91..cd4d5fdb7b87 100644 --- a/api-guide/source/polling_changes-since_parameter.rst +++ b/api-guide/source/polling_changes-since_parameter.rst @@ -16,7 +16,7 @@ nothing has changed since the *``changes-since``* time, an empty list is returned. If data has changed, only the items changed since the specified time are returned in the response. For example, performing a **GET** against -https://api.servers.openstack.org/v2/224532/servers?\ *``changes-since``*\ =2015-01-24T17:08Z +https://api.servers.openstack.org/v2.1/servers?\ *``changes-since``*\ =2015-01-24T17:08Z would list all servers that have changed since Mon, 24 Jan 2015 17:08:00 UTC. diff --git a/api-guide/source/request_and_response_formats.rst b/api-guide/source/request_and_response_formats.rst index 0ca63b7372f2..73db8b32422e 100644 --- a/api-guide/source/request_and_response_formats.rst +++ b/api-guide/source/request_and_response_formats.rst @@ -16,7 +16,7 @@ The example below shows a request body in JSON format: .. code:: - POST /v2/010101/servers HTTP/1.1 + POST /v2.1/servers HTTP/1.1 Host: servers.api.openstack.org X-Auth-Token: eaaafd18-0fed-4b3a-81b4-663c99ec1cbb