From 13c0c40961869dd60b6a7ed59c87896eaa0bc6ca Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Mon, 11 Mar 2013 16:02:20 -0400 Subject: [PATCH] Add deprecation warnings for V1 API Add warnings to the documentation for users and to the source for developers. Change-Id: Ic4695a8d1e4d2bc2d53b0bb69806c933f1b672aa Signed-off-by: Doug Hellmann --- ceilometer/api/v1/blueprint.py | 9 +++++++++ doc/source/webapi/v1.rst | 5 +++++ 2 files changed, 14 insertions(+) diff --git a/ceilometer/api/v1/blueprint.py b/ceilometer/api/v1/blueprint.py index a4c20d283..ec7cd1d11 100644 --- a/ceilometer/api/v1/blueprint.py +++ b/ceilometer/api/v1/blueprint.py @@ -18,6 +18,15 @@ """Blueprint for version 1 of API. """ +############################################################################# +############################################################################# +# +# NOTE(dhellmann): The V1 API is being deprecated during Havana, and +# as such it is feature-frozen. Only make bug-fix changes in this file. +# +############################################################################# +############################################################################# + # [ ] / -- information about this version of the API # # [ ] /extensions -- list of available extensions diff --git a/doc/source/webapi/v1.rst b/doc/source/webapi/v1.rst index a4faa483a..c369cae9b 100644 --- a/doc/source/webapi/v1.rst +++ b/doc/source/webapi/v1.rst @@ -2,5 +2,10 @@ V1 Web API ============ +.. warning:: + + The V1 API is being deprecated during the Havana development + cycle. Please use the V2 API instead. + .. autoflask:: ceilometer.api.v1.app:app :undoc-static: