Pārlūkot izejas kodu

updated search api docs to include pagination changes

Signed-off-by: Nathan Hsieh <hsieh.nathan@gmail.com>
Nathan Hsieh 10 gadi atpakaļ
vecāks
revīzija
686585f33a
1 mainītis faili ar 3 papildinājumiem un 1 dzēšanām
  1. 3 1
      docs/sources/reference/api/registry_api.md

+ 3 - 1
docs/sources/reference/api/registry_api.md

@@ -514,7 +514,7 @@ Search the Index given a search term. It accepts
 
 **Example request**:
 
-        GET /v1/search?q=search_term HTTP/1.1
+        GET /v1/search?q=search_term&page=1&n=25 HTTP/1.1
         Host: index.docker.io
         Accept: application/json
 
@@ -536,6 +536,8 @@ Search the Index given a search term. It accepts
 Query Parameters:
 
 - **q** – what you want to search for
+- **n** - number of results you want returned per page (default: 25)
+- **page** - page number of results
 
 Status Codes: