Browse Source

Merge pull request #8531 from SvenDowideit/move-registry-search-to-registry-api

Move registry search API docs into the registry API document.
Fred Lifton 10 years ago
parent
commit
6ce4f82ebe

+ 0 - 41
docs/sources/reference/api/docker-io_api.md

@@ -503,44 +503,3 @@ Status Codes:
 - **401** – Unauthorized
 - **403** – Account is not Active
 - **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

+ 41 - 0
docs/sources/reference/api/registry_api.md

@@ -494,6 +494,47 @@ Status Codes:
 - **401** – Requires authorization
 - **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 check for registry