added Docker Index search API doc

This commit is contained in:
Ken Cochrane 2013-05-02 14:32:38 -04:00
Родитель ff5e238de9
Коммит b682a8ea9e
3 изменённых файлов: 36 добавлений и 0 удалений

Просмотреть файл

@ -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..."},
]
}