[pve-devel] r4981 - pve-common/trunk

[svn-commits at proxmox.com]

Author: dietmar
Date: 2010-08-12 11:48:51 +0000 (Thu, 12 Aug 2010)
New Revision: 4981

Modified:
   pve-common/trunk/README.dev
Log:


Modified: pve-common/trunk/README.dev
===================================================================
--- pve-common/trunk/README.dev	2010-08-12 11:36:37 UTC (rev 4980)
+++ pve-common/trunk/README.dev	2010-08-12 11:48:51 UTC (rev 4981)
@@ -24,16 +24,25 @@
 web browser.
 
 Additionaly, we use JSON Schema [2] to formally describe our API. So
-we can automatically generate the whole API Documentation.
+we can automatically generate the whole API Documentation, and we can
+verify all parameters and return values if they conform to the schema.
 
 An great side effect was that we are able to use JSON Schema to
 produce command line argument parser automatically. In fact, the REST
 API and the command line tools use the same code.
 
+Object linkage is done using the JSON Hyper Schema (links property).
+
 A small utility called 'pvesh' exposes the whole REST API on the command
 line.
 
+So here is a sumary of the advantage:
 
+   - easy, human readable data format (native web browser format)
+   - automatic parameter verification (we can also verify return values)
+   - automatic generation of API documentation
+   - easy way to create command line tools (using same API).
+
 References
 ==========
 [1] RESTful Web Services