mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
added Docker Index search API doc
This commit is contained in:
parent
ff5e238de9
commit
b682a8ea9e
3 changed files with 36 additions and 0 deletions
|
@ -16,6 +16,7 @@ This documentation has the following resources:
|
||||||
contributing/index
|
contributing/index
|
||||||
commandline/index
|
commandline/index
|
||||||
registry/index
|
registry/index
|
||||||
|
index/index
|
||||||
faq
|
faq
|
||||||
|
|
||||||
|
|
||||||
|
|
15
docs/sources/index/index.rst
Normal file
15
docs/sources/index/index.rst
Normal file
|
@ -0,0 +1,15 @@
|
||||||
|
:title: Docker Index documentation
|
||||||
|
:description: Documentation for docker Index
|
||||||
|
:keywords: docker, index, api
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Index
|
||||||
|
=====
|
||||||
|
|
||||||
|
Contents:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
search
|
20
docs/sources/index/search.rst
Normal file
20
docs/sources/index/search.rst
Normal file
|
@ -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..."},
|
||||||
|
]
|
||||||
|
}
|
Loading…
Add table
Reference in a new issue