From 70c14a39fbcf5a0728f56377d5bd530f89db150d Mon Sep 17 00:00:00 2001 From: Nathan Hsieh Date: Mon, 29 Dec 2014 10:39:09 -0800 Subject: [PATCH 1/4] updated search api docs to include pagination changes Signed-off-by: Nathan Hsieh Upstream-commit: 686585f33a80f7dfaa45400b700235d0615b7fce Component: engine --- components/engine/docs/sources/reference/api/registry_api.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/components/engine/docs/sources/reference/api/registry_api.md b/components/engine/docs/sources/reference/api/registry_api.md index 43a463cd5e..8648162149 100644 --- a/components/engine/docs/sources/reference/api/registry_api.md +++ b/components/engine/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: From d4fbd0ffc55b01aa372345156e40bf4a6a1c076a Mon Sep 17 00:00:00 2001 From: Nathan Hsieh Date: Fri, 2 Jan 2015 16:21:51 -0800 Subject: [PATCH 2/4] updated docs with information regarding search pagination Signed-off-by: Nathan Hsieh Upstream-commit: 1aac999f707773e4530c1d126ce51ec19cf9d243 Component: engine --- .../sources/reference/api/registry_api.md | 25 +++++++++++++------ 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/components/engine/docs/sources/reference/api/registry_api.md b/components/engine/docs/sources/reference/api/registry_api.md index 8648162149..54a158934a 100644 --- a/components/engine/docs/sources/reference/api/registry_api.md +++ b/components/engine/docs/sources/reference/api/registry_api.md @@ -518,26 +518,37 @@ Search the Index given a search term. It accepts Host: index.docker.io Accept: application/json +Query Parameters: + +- **q** – what you want to search for +- **n** - number of results you want returned per page (default: 25, min:1, max:100) +- **page** - page number of results + **Example response**: HTTP/1.1 200 OK Vary: Accept Content-Type: application/json - {"query":"search_term", + {"num_pages": 1, "num_results": 3, "results" : [ {"name": "ubuntu", "description": "An ubuntu image..."}, {"name": "centos", "description": "A centos image..."}, {"name": "fedora", "description": "A fedora image..."} - ] + ], + "page_size": 25, + "query":"search_term", + "page": 1 } -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 +Response Items: +- **num_pages** - Total number of pages returned by query +- **num_results** - Total number of results returned by query +- **results** - List of results for the current page +- **page_size** - How many results returned per page +- **query** - Your search term +- **page** - Current page number Status Codes: From c72b573e2b35abd06c88bae89144c787520f0946 Mon Sep 17 00:00:00 2001 From: Nathan Hsieh Date: Wed, 14 Jan 2015 18:03:09 -0800 Subject: [PATCH 3/4] added note to man & cli docs on search limit Signed-off-by: Nathan Hsieh Upstream-commit: 92ef40a8260e5e8dcd5579a6f9d942c4e68702ed Component: engine --- components/engine/docs/man/docker-search.1.md | 2 ++ components/engine/docs/sources/reference/commandline/cli.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/components/engine/docs/man/docker-search.1.md b/components/engine/docs/man/docker-search.1.md index 3937b870a3..8f3d81e08e 100644 --- a/components/engine/docs/man/docker-search.1.md +++ b/components/engine/docs/man/docker-search.1.md @@ -18,6 +18,8 @@ of images returned displays the name, description (truncated by default), number of stars awarded, whether the image is official, and whether it is automated. +*Note* - Search queries will only return up to 25 results + # OPTIONS **--automated**=*true*|*false* Only show automated builds. The default is *false*. diff --git a/components/engine/docs/sources/reference/commandline/cli.md b/components/engine/docs/sources/reference/commandline/cli.md index aab3d6af47..e6f75e0ca0 100644 --- a/components/engine/docs/sources/reference/commandline/cli.md +++ b/components/engine/docs/sources/reference/commandline/cli.md @@ -1868,6 +1868,8 @@ See [*Find Public Images on Docker Hub*]( /userguide/dockerrepos/#searching-for-images) for more details on finding shared images from the command line. +*Note* - Search queries will only return up to 25 results + ## start Usage: docker start [OPTIONS] CONTAINER [CONTAINER...] From 3b76395570cf396b0738787c7c304906e23f8abe Mon Sep 17 00:00:00 2001 From: Nathan Hsieh Date: Thu, 15 Jan 2015 08:39:16 -0800 Subject: [PATCH 4/4] changed format of cli note Signed-off-by: Nathan Hsieh Upstream-commit: c252d5f3f4fc98062fbda6335a04cca2602a4223 Component: engine --- components/engine/docs/sources/reference/commandline/cli.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/components/engine/docs/sources/reference/commandline/cli.md b/components/engine/docs/sources/reference/commandline/cli.md index e6f75e0ca0..9254e9cdd2 100644 --- a/components/engine/docs/sources/reference/commandline/cli.md +++ b/components/engine/docs/sources/reference/commandline/cli.md @@ -1868,7 +1868,8 @@ See [*Find Public Images on Docker Hub*]( /userguide/dockerrepos/#searching-for-images) for more details on finding shared images from the command line. -*Note* - Search queries will only return up to 25 results +> **Note:** +> Search queries will only return up to 25 results ## start