added Docker Index search API doc

Upstream-commit: b682a8ea9e9325278cdb08d5f3da821ee97c5feb Component: engine
2013-05-02 14:32:38 -04:00
parent 113b997422
commit d45e7db4d1
3 changed files with 36 additions and 0 deletions
@@ -16,6 +16,7 @@ This documentation has the following resources:
   contributing/index
   commandline/index
   registry/index
+   index/index
   faq


@@ -0,0 +1,15 @@
+:title: Docker Index documentation
+:description: Documentation for docker Index
+:keywords: docker, index, api
+
+
+
+Index
+=====
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   search
@@ -0,0 +1,20 @@
+=======================
+Docker Index Search API
+=======================
+
+Search
+------
+
+**URL:** /v1/search?q={{search_term}}
+
+**Results:**
+
+.. code-block:: json
+
+   {"query":"{{search_term}}",
+    "num_results": 27,
+    "results" : [
+       {"name": "dotcloud/base", "description": "A base ubuntu64  image..."},
+       {"name": "base2", "description": "A base ubuntu64  image..."},
+     ]
+   }