openstack
/
qa-specs
Code Issues Proposed changes

Add working items to consistent-service-method-names 

We have discussed the detail of bp/consistent-service-method-names at
Vancouver Summit. This patch adds it as the conclusion.

Partially implements blueprint consistent-service-method-names

Change-Id: If1c7d6ad4be79dc74b3d8a14a7f7e8fa0d4c8418
This commit is contained in:
Ken'ichi Ohmichi 2015-07-02 02:12:12 +00:00 committed by Matthew Treinish
parent c5b1920556
commit 686a9096e3
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
specs/tempest/consistent-service-method-names.rst
View File

@ -120,6 +120,18 @@ resource names are the same between a single noun and multiple nouns like
"chassis". So it is better to avoid using "get_<resource name>" for clarifying
the method behavior. The hacking check of this rule is mentioned at the above.
Separate service client modules for each resource
-------------------------------------------------
Some service clients contain the methods for multiple resources in a single
module. For example, server_client module contains the methods for "/servers"
and "/server_groups". Current separation of modules are inconsistent, and
this spec proposes all service client modules will be separated into a single
module by each resource.
In addition, current modules of service clients contain "JSON" in these names
but we need to remove them. Because current service clients supports JSON only
and "JSON" in these names are meaningless now.
Implementation
==============
@ -144,4 +156,12 @@ Work Items
----------
* Rename service clients' methods based on this proposal.
* Rename service clients' classes based on this proposal.
* Separate service clients' modules per resources.
* Add hacking rules based on this proposal.
References
==========
* We have discussed this working items at Vancouver Summit.
The log is https://etherpad.openstack.org/p/YVR-QA-Tempest-service-clients