openstack/api-sig
Code Issues Proposed changes

Add generic name of each project for terms

Browse Source 
We are discussing API Microversions header names and this patch
tries to build the consensus.

http://lists.openstack.org/pipermail/openstack-dev/2015-June/066957.html

Change-Id: I8ad9313f824ef656c841a9b60ee575f02ddea321
Depends-On: I1d74149b1f9f7739a630e2b52392a786a414776e
This commit is contained in:
Ken'ichi Ohmichi 2015-06-30 00:21:13 +00:00 committed by Ken'ichi Ohmichi
parent 35bf769df5
commit 07a7aafbf3
1 changed files with 11 additions and 0 deletions

11
guidelines/terms.rst

@ -25,3 +25,14 @@ made regarding certain terms, and attempts to succinctly define each term.
**instance** that is also by Amazon Web Services EC2 API to
describe a virtual machine, should *not* be used in OpenStack REST
APIs.
* **project name** vs. **service type**
Each OpenStack project has both a "project name" (e.g., Nova, Keystone, etc.)
and a "service type" (e.g., Compute, Identity, etc.). Some REST API features
(e.g., JSON-Home, API Microversions, etc.) need to expose each project in a
request/response.
The project *should* be represented with its **service type** because its
project name is subject to change (e.g., Neutron was Quantum) and its service
type is more stable. The service type should come from "type" of the
corresponding OpenStack Identity service catalog entry.