openstack/zaqar
Code Issues Proposed changes

Added checks enforcements rule to the developers manual

Browse Source 
This change adds the convention we established for checks
during the weekly meeting on 01-09-2014 to the developers docs.

Change-Id: I2b202ac018435b7c671490f9f036e700685e85f3
This commit is contained in:
Victoria Martínez de la Cruz 2014-09-14 18:53:43 -03:00
parent 438d1a8cf0
commit dd553f6b2f
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/source/index.rst
View File

@ -128,12 +128,27 @@ API reference
Modules reference Modules reference
================= =================
Zaqar is composed of two layers:
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
transport transport
storage storage
The **transport drivers** are responsible for interacting with Zaqar clients.
Every query made by clients is processed by the transport layer,
which is in charge of passing this information to the backend and then
returning the response in a format understandable by the client.
The **storage drivers** are responsible for interacting with the storage backends
and, that way, store or retrieve the data coming from the transport layer.
In order to keep these layers decoupled, we have established that
**checks should be performed in the appropriate layer**. In other words,
transport drivers must guarantee that the incoming data is well-formed
and storage drivers must enforce their data model stays consistent.
Indices and tables Indices and tables
------------------ ------------------