From b682a8ea9e9325278cdb08d5f3da821ee97c5feb Mon Sep 17 00:00:00 2001 From: Ken Cochrane Date: Thu, 2 May 2013 14:32:38 -0400 Subject: [PATCH] added Docker Index search API doc --- docs/sources/index.rst | 1 + docs/sources/index/index.rst | 15 +++++++++++++++ docs/sources/index/search.rst | 20 ++++++++++++++++++++ 3 files changed, 36 insertions(+) create mode 100644 docs/sources/index/index.rst create mode 100644 docs/sources/index/search.rst diff --git a/docs/sources/index.rst b/docs/sources/index.rst index 4e724a0cd..e6a1482cc 100644 --- a/docs/sources/index.rst +++ b/docs/sources/index.rst @@ -16,6 +16,7 @@ This documentation has the following resources: contributing/index commandline/index registry/index + index/index faq diff --git a/docs/sources/index/index.rst b/docs/sources/index/index.rst new file mode 100644 index 000000000..7637a4e77 --- /dev/null +++ b/docs/sources/index/index.rst @@ -0,0 +1,15 @@ +:title: Docker Index documentation +:description: Documentation for docker Index +:keywords: docker, index, api + + + +Index +===== + +Contents: + +.. toctree:: + :maxdepth: 2 + + search diff --git a/docs/sources/index/search.rst b/docs/sources/index/search.rst new file mode 100644 index 000000000..0c7624de7 --- /dev/null +++ b/docs/sources/index/search.rst @@ -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..."}, + ] + } \ No newline at end of file