Browse code

added Docker Index search API doc

Ken Cochrane authored on 2013/05/03 03:32:38
Showing 3 changed files
... ...
@@ -16,6 +16,7 @@ This documentation has the following resources:
16 16
    contributing/index
17 17
    commandline/index
18 18
    registry/index
19
+   index/index
19 20
    faq
20 21
 
21 22
 
22 23
new file mode 100644
... ...
@@ -0,0 +1,15 @@
0
+:title: Docker Index documentation
1
+:description: Documentation for docker Index
2
+:keywords: docker, index, api
3
+
4
+
5
+
6
+Index
7
+=====
8
+
9
+Contents:
10
+
11
+.. toctree::
12
+   :maxdepth: 2
13
+
14
+   search
0 15
new file mode 100644
... ...
@@ -0,0 +1,20 @@
0
+=======================
1
+Docker Index Search API
2
+=======================
3
+
4
+Search
5
+------
6
+
7
+**URL:** /v1/search?q={{search_term}}
8
+
9
+**Results:**
10
+
11
+.. code-block:: json
12
+
13
+   {"query":"{{search_term}}",
14
+    "num_results": 27,
15
+    "results" : [
16
+       {"name": "dotcloud/base", "description": "A base ubuntu64  image..."},
17
+       {"name": "base2", "description": "A base ubuntu64  image..."},
18
+     ]
19
+   }
0 20
\ No newline at end of file