openstack/glance-specs
Code Issues Proposed changes

api-docs: deprecate the Images v1 API

Browse Source 
This patch updates the "narrative" Images v1 API docs for the
Newton release by adding a deprecation note to each page.  That
way the note will be seen even if someone uses a direct link to
one of the pages.

The Images v1 API was deprecated with commit
63e6dbb1eb006758fbcf7cae83e1d2eacf46b4ab.

Change-Id: I62315efc12ee05aea5f55d020006cbb2ad279876
Partial-bug: #1618495
This commit is contained in:
Brian Rosmaita 2016-09-14 22:13:57 -04:00
parent 484999de76
commit 83ad95084a
14 changed files with 32 additions and 0 deletions

2
doc/source/index.rst

@ -63,6 +63,8 @@ Image service V2 API
Image service V1 API
====================
.. include:: specs/api/v1/deprecation-note.inc
.. toctree::
:maxdepth: 1

2
specs/api/v1/adding_a_member_to_an_image.rst

@ -2,6 +2,8 @@
Adding a Member to an Image
===========================
.. include:: deprecation-note.inc
We want to authorize a tenant to access a private image. We issue a
``PUT`` request to
``http://glance.example.com/images/1/members/tenant1``. With no body,

2
specs/api/v1/adding_a_new_virtual_machine_image.rst

@ -2,6 +2,8 @@
Adding a New Virtual Machine Image
==================================
.. include:: deprecation-note.inc
We have created a new virtual machine image in some way (created a
"golden image" or snapshotted/backed up an existing image) and we wish
to do two things:

2
specs/api/v1/authentication.rst

@ -1,6 +1,8 @@
Authentication
--------------
.. include:: deprecation-note.inc
You can optionally integrate Glance with the OpenStack Identity Service
project. Setting this up is relatively straightforward: the Identity
Service distribution at http://github.com/openstack/keystone includes

6
specs/api/v1/deprecation-note.inc Normal file

@ -0,0 +1,6 @@
.. note:: The Images API v1 has been DEPRECATED in the Newton release. The
migration path is to use the `Images API v2
<http://developer.openstack.org/api-ref/image/v2/>`_ instead of version 1
of the API. The Images API v1 will ultimately be removed, following the
`OpenStack standard deprecation policy
<https://governance.openstack.org/reference/tags/assert_follows-standard-deprecation.html>`_.

2
specs/api/v1/filtering_images_returned_via_get__images_and_get__images_detail.rst

@ -2,6 +2,8 @@
Filtering Images Returned via GET /images and GET /images/detail
================================================================
.. include:: deprecation-note.inc
Both the ``GET /images`` and ``GET /images/detail`` requests
take query parameters that serve to filter the returned list of images.
The following list details these query parameters.

2
specs/api/v1/image_service_v1_api.rst

@ -2,6 +2,8 @@
Image service v1 REST API
=========================
.. include:: deprecation-note.inc
The OpenStack Image service offers retrieval, storage, and metadata
assignment for your images that you want to run in your OpenStack cloud.
The project is code-named Glance.

2
specs/api/v1/removing_a_member_from_an_image.rst

@ -2,6 +2,8 @@
Removing a Member from an Image
===============================
.. include:: deprecation-note.inc
We want to revoke a tenant's right to access a private image. We issue a
``DELETE`` request to
``http://glance.example.com/images/1/members/tenant1``. This query will

2
specs/api/v1/replacing_a_membership_list_for_an_image.rst

@ -2,6 +2,8 @@
Replacing a Membership List for an Image
========================================
.. include:: deprecation-note.inc
The full membership list for a given image may be replaced. We issue a
``PUT`` request to ``http://glance.example.com/images/1/members`` with a
body of the following form:

2
specs/api/v1/requesting_detailed_metadata_on_a_specific_image.rst

@ -2,6 +2,8 @@
Requesting Detailed Metadata on a Specific Image
================================================
.. include:: deprecation-note.inc
We want to see detailed information for a specific virtual machine image
that the Glance server knows about.

2
specs/api/v1/requesting_detailed_metadata_on_public_vm_images.rst

@ -2,6 +2,8 @@
Requesting Detailed Metadata on Public VM Images
================================================
.. include:: deprecation-note.inc
We want to see more detailed information on available virtual machine
images that the Glance server knows about.

2
specs/api/v1/requesting_image_memberships.rst

@ -2,6 +2,8 @@
Requesting Image Memberships
============================
.. include:: deprecation-note.inc
We want to see a list of the other system tenants (or users, if
"owner\_is\_tenant" is False) that may access a given virtual machine
image that the Glance server knows about. We take the \`uri\` field of

2
specs/api/v1/requesting_shared_images.rst

@ -2,6 +2,8 @@
Requesting Shared Images
========================
.. include:: deprecation-note.inc
We want to see a list of images which are shared with a given tenant. We
issue a ``GET`` request to
``http://glance.example.com/shared-images/tenant1``. We will get back

2
specs/api/v1/retrieving_a_virtual_machine_image.rst

@ -2,6 +2,8 @@
Retrieving a Virtual Machine Image
==================================
.. include:: deprecation-note.inc
We want to retrieve that actual raw data for a specific virtual machine
image that the Glance server knows about.