From dd553f6b2fcbc60bbec92d8fbdcaf6666ed68abe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Victoria=20Mart=C3=ADnez=20de=20la=20Cruz?= Date: Sun, 14 Sep 2014 18:53:43 -0300 Subject: [PATCH] Added checks enforcements rule to the developers manual This change adds the convention we established for checks during the weekly meeting on 01-09-2014 to the developers docs. Change-Id: I2b202ac018435b7c671490f9f036e700685e85f3 --- doc/source/index.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/source/index.rst b/doc/source/index.rst index 8c5fe3f52..139c21cec 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -128,12 +128,27 @@ API reference Modules reference ================= +Zaqar is composed of two layers: + .. toctree:: :maxdepth: 1 transport 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 ------------------