1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00

Move registry search API docs into the registry API document.

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
This commit is contained in:
Sven Dowideit 2014-10-14 11:52:10 +10:00
parent 9d5e3a54a0
commit 6b285c4cd6
2 changed files with 41 additions and 41 deletions

View file

@ -503,44 +503,3 @@ Status Codes:
- **401** Unauthorized - **401** Unauthorized
- **403** Account is not Active - **403** Account is not Active
- **404** User not found - **404** User not found
## Search
If you need to search the index, this is the endpoint you would use.
`GET /v1/search`
Search the Index given a search term. It accepts
[GET](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.3)
only.
**Example request**:
GET /v1/search?q=search_term HTTP/1.1
Host: index.docker.io
Accept: application/json
**Example response**:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
{"query":"search_term",
"num_results": 3,
"results" : [
{"name": "ubuntu", "description": "An ubuntu image..."},
{"name": "centos", "description": "A centos image..."},
{"name": "fedora", "description": "A fedora image..."}
]
}
Query Parameters:
- **q** what you want to search for
Status Codes:
- **200** no error
- **500** server error

View file

@ -494,6 +494,47 @@ Status Codes:
- **401** Requires authorization - **401** Requires authorization
- **404** Repository not found - **404** Repository not found
## Search
If you need to search the index, this is the endpoint you would use.
`GET /v1/search`
Search the Index given a search term. It accepts
[GET](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.3)
only.
**Example request**:
GET /v1/search?q=search_term HTTP/1.1
Host: index.docker.io
Accept: application/json
**Example response**:
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
{"query":"search_term",
"num_results": 3,
"results" : [
{"name": "ubuntu", "description": "An ubuntu image..."},
{"name": "centos", "description": "A centos image..."},
{"name": "fedora", "description": "A fedora image..."}
]
}
Query Parameters:
- **q** what you want to search for
Status Codes:
- **200** no error
- **500** server error
## Status ## Status
### Status check for registry ### Status check for registry