Add small API documentation

rande · rande · commit a4918aed24ef · 2014-02-26T19:23:05.000-05:00
diff --git a/docs/plugins/api.rst b/docs/plugins/api.rst
@@ -1,40 +1,69 @@
-.. note::
-
-    This documentation is under construction, more to come soon
-
-
-
 Api
 ===
 
-expose your data through a json api
-
 Features
-~~~~~~~~
+--------
 
-  - Insert here the different feature available for this plugin
+  - Expose node from the datasource through a RESTful API.
 
 Configuration
-~~~~~~~~~~~~~
+-------------
+
+You need to enable the plugin by adding this line into the IoC configuration file.
+
+.. code-block:: yaml
+
+    element.plugins.api:
 
-  - Insert the yaml configuration for the DI
+Then, you must have a node api as defined in your datasource:
 
 .. code-block:: yaml
 
-    element.plugins.cache:
-        cache_control:
-            - { "path": "^.*\\.(txt|jpg|png|gif|xls|doc|docx)$",    "Cache-Control": ['public', 's-maxage=14212800']}
-            - { "path": "^(blog|gallery).*",    "Cache-Control": ['public', 's-maxage=3600']}
-            - { "path": "^.*\\.rss",            "Cache-Control": ['public', 's-maxage=3600']}
-            - { "path": "^contact.*",           "Cache-Control": ['private', 'must-revalidate']}
-            - { "path": "^/$",                  "Cache-Control": ['public', 's-maxage=3600']}
+    # api.yml
+    title: API
+    type: action.collection
+    actions:
+        element_api_node:
+            path: /element/node/<path:path>.<_format>
+            methods: ['GET', 'PUT', 'POST', 'DELETE']
+            defaults:
+                _controller: element.api.view.node:execute
+
+        element_api_list_index:
+            path: /element/node.<_format>
+            methods: ['GET']
+            defaults:
+                _controller: element.api.view.node.list:execute
+                path: /
+
+        element_api_list:
+            path: /element/path/<path:path>.<_format>
+            methods: ['GET']
+            defaults:
+                _controller: element.api.view.node.list:execute
 
-Events
-~~~~~~
+        element_api_handler_list:
+            path: /element/handlers.<_format>
+            methods: ['GET']
+            defaults:
+                _controller: element.api.view.handler.list:execute
+
+        element_api_handler:
+            path: /element/handler/<code>.<_format>
+            methods: ['GET']
+            defaults:
+                _controller: element.api.view.handler:execute
+
+
+.. note::
 
- - List event or entry points for this plugin
+    The API is not stable.
 
-Architecture
-~~~~~~~~~~~~
+Usage
+-----
 
- - Provide information about how the feature is implemented
+ - ``GET /api/element/handlers.json`` : return the list of handlers
+ - ``GET /api/element/node.json``: return the different node available
+ - ``GET /api/element/node/{ID}.json``: get a node
+ - ``POST /api/element/node/{ID}.json``: update a node
+ - ``PUT /api/element/node/{ID}.json``: create a node
diff --git a/element/plugins/api/views.py b/element/plugins/api/views.py
@@ -86,7 +86,22 @@ def get(self, context, path, **kwargs):
             'results': []
         }
 
-        for node in self.node_manager.get_nodes(path=path):
+        limit = 32
+        offset = 0
+
+        if "limit" in kwargs:
+            limit = int(kwargs["limit"])
+
+        if "offset" in kwargs:
+            offset = int(kwargs["offset"])
+
+        if limit > 32 or limit < 0:
+            limit = 32
+
+        if offset < 0:
+            offset = 0
+
+        for node in self.node_manager.get_nodes(path=path, limit=limit, offset=offset):
             data['results'].append(self.serialize_node(node))
 
         return data, 200
