From 189334067a625b6957ad75ee7a6019120e93ae2b Mon Sep 17 00:00:00 2001 From: wanghao Date: Tue, 16 Nov 2021 14:51:11 +0800 Subject: [PATCH] Remove V1 APIs from Zaqar MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Currently, Zaqar has tree versions of APIs, V1, V1_1 and V2. The V1 is the oldest apis that there is no need for them right now. All new features are implemented under V2 APIs. So it’s time to remove V1 APIs and optimize the Zaqar's codes. Change-Id: Ib227ffd428935cd1849c5bf84a22bfa4f542bc8e Implements: blueprint remove-v1-api-code --- specs/yoga/index.rst | 2 + specs/yoga/remove-v1-api-code-from-zaqar.rst | 91 ++++++++++++++++++++ 2 files changed, 93 insertions(+) create mode 100644 specs/yoga/remove-v1-api-code-from-zaqar.rst diff --git a/specs/yoga/index.rst b/specs/yoga/index.rst index 5f6de54..b86fba4 100644 --- a/specs/yoga/index.rst +++ b/specs/yoga/index.rst @@ -5,3 +5,5 @@ .. toctree:: :glob: :maxdepth: 2 + + remove-v1-api-code-from-zaqar diff --git a/specs/yoga/remove-v1-api-code-from-zaqar.rst b/specs/yoga/remove-v1-api-code-from-zaqar.rst new file mode 100644 index 0000000..6e4a745 --- /dev/null +++ b/specs/yoga/remove-v1-api-code-from-zaqar.rst @@ -0,0 +1,91 @@ +.. + This template should be in ReSTructured text. The filename in the git + repository should match the launchpad URL, for example a URL of + https://blueprints.launchpad.net/zaqar/+spec/awesome-thing should be named + awesome-thing.rst. + + Please do not delete any of the sections in this + template. If you have nothing to say for a whole section, just write: None + + For help with syntax, see http://sphinx-doc.org/rest.html + To test out your formatting, see http://www.tele3.cz/jbar/rest/rest.html + +============================= +Remove V1 API Code From Zaqar +============================= + +https://blueprints.launchpad.net/zaqar/+spec/remove-v1-api-code + +Now there is no need for V1 APIs, its old and could be completely replaced by V2 APIs. +So it's time to remove it from the code tree. This action is first one of steps to optimize +Zaqar's codes and functions. + +Problem description +=================== + +Currently, Zaqar has tree versions of APIs, V1, V1_1 and V2. The V1 is the oldest apis that +there is no need for them right now. All new features are implemented under V2 APIs. So +its time to remove V1 APIs and optimize the Zaqar's codes. + +Proposed change +=============== + +1. Remove all V1 APIs codes and change the basic APIs to V1_1. + +2. Clean the unit tests and tempest tests about V1 APIs. + +3. Modify the API doc according the changes. + +API Impact +----------- + +The whole V1 APIs code will be removed from Zaqar's service. + +Drawbacks +--------- + +If someone are still using V1 APIs, they must change the API version to +V1_1 or V2(best to V2) after Yoga release. + +Alternatives +------------ + +None + +Implementation +============== + +Assignee(s) +----------- + +Primary assignee: + wanghao + +Secondary assignee: + None + +Milestones +---------- + +Target Milestone for completion: + Yoga M-1 + +Work Items +---------- + +#. Remove V1 api and transport code. +#. Remove unit and functional tests for V1. +#. Add release note for this feature. +#. Update API reference according those changes. +#. Change tempest tests accordingly. +#. remove client support. + +Dependencies +============ + +None + +References +========== + +None