Browse code
Move registry search API docs into the registry API document.
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
Sven Dowideit authored on 2014/10/14 10:52:10Showing 2 changed files
| ... | ... |
@@ -503,44 +503,3 @@ Status Codes: |
| 503 | 503 |
- **401** – Unauthorized |
| 504 | 504 |
- **403** – Account is not Active |
| 505 | 505 |
- **404** – User not found |
| 506 |
- |
|
| 507 |
-## Search |
|
| 508 |
- |
|
| 509 |
-If you need to search the index, this is the endpoint you would use. |
|
| 510 |
- |
|
| 511 |
-`GET /v1/search` |
|
| 512 |
- |
|
| 513 |
-Search the Index given a search term. It accepts |
|
| 514 |
- |
|
| 515 |
- [GET](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.3) |
|
| 516 |
- only. |
|
| 517 |
- |
|
| 518 |
-**Example request**: |
|
| 519 |
- |
|
| 520 |
- GET /v1/search?q=search_term HTTP/1.1 |
|
| 521 |
- Host: index.docker.io |
|
| 522 |
- Accept: application/json |
|
| 523 |
- |
|
| 524 |
-**Example response**: |
|
| 525 |
- |
|
| 526 |
- HTTP/1.1 200 OK |
|
| 527 |
- Vary: Accept |
|
| 528 |
- Content-Type: application/json |
|
| 529 |
- |
|
| 530 |
- {"query":"search_term",
|
|
| 531 |
- "num_results": 3, |
|
| 532 |
- "results" : [ |
|
| 533 |
- {"name": "ubuntu", "description": "An ubuntu image..."},
|
|
| 534 |
- {"name": "centos", "description": "A centos image..."},
|
|
| 535 |
- {"name": "fedora", "description": "A fedora image..."}
|
|
| 536 |
- ] |
|
| 537 |
- } |
|
| 538 |
- |
|
| 539 |
-Query Parameters: |
|
| 540 |
- |
|
| 541 |
-- **q** – what you want to search for |
|
| 542 |
- |
|
| 543 |
-Status Codes: |
|
| 544 |
- |
|
| 545 |
-- **200** – no error |
|
| 546 |
-- **500** – server error |
| ... | ... |
@@ -494,6 +494,47 @@ Status Codes: |
| 494 | 494 |
- **401** – Requires authorization |
| 495 | 495 |
- **404** – Repository not found |
| 496 | 496 |
|
| 497 |
+## Search |
|
| 498 |
+ |
|
| 499 |
+If you need to search the index, this is the endpoint you would use. |
|
| 500 |
+ |
|
| 501 |
+`GET /v1/search` |
|
| 502 |
+ |
|
| 503 |
+Search the Index given a search term. It accepts |
|
| 504 |
+ |
|
| 505 |
+ [GET](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#sec9.3) |
|
| 506 |
+ only. |
|
| 507 |
+ |
|
| 508 |
+**Example request**: |
|
| 509 |
+ |
|
| 510 |
+ GET /v1/search?q=search_term HTTP/1.1 |
|
| 511 |
+ Host: index.docker.io |
|
| 512 |
+ Accept: application/json |
|
| 513 |
+ |
|
| 514 |
+**Example response**: |
|
| 515 |
+ |
|
| 516 |
+ HTTP/1.1 200 OK |
|
| 517 |
+ Vary: Accept |
|
| 518 |
+ Content-Type: application/json |
|
| 519 |
+ |
|
| 520 |
+ {"query":"search_term",
|
|
| 521 |
+ "num_results": 3, |
|
| 522 |
+ "results" : [ |
|
| 523 |
+ {"name": "ubuntu", "description": "An ubuntu image..."},
|
|
| 524 |
+ {"name": "centos", "description": "A centos image..."},
|
|
| 525 |
+ {"name": "fedora", "description": "A fedora image..."}
|
|
| 526 |
+ ] |
|
| 527 |
+ } |
|
| 528 |
+ |
|
| 529 |
+Query Parameters: |
|
| 530 |
+ |
|
| 531 |
+- **q** – what you want to search for |
|
| 532 |
+ |
|
| 533 |
+Status Codes: |
|
| 534 |
+ |
|
| 535 |
+- **200** – no error |
|
| 536 |
+- **500** – server error |
|
| 537 |
+ |
|
| 497 | 538 |
## Status |
| 498 | 539 |
|
| 499 | 540 |
### Status check for registry |