From a5c5dc121c794daa199a813a95c0affd766a18f4 Mon Sep 17 00:00:00 2001 From: Lachlan Coote Date: Thu, 31 Jul 2014 19:26:32 -0700 Subject: [PATCH] #1852 Remote API documentation incorrect regarding private registries Issues addressed: - Remote API doco refers to "registry" parameter which is not supported - Neglects to mention "tag" parameter which is supported - Offers no guidance on pushing to private registries Changes made: - As directed in review comments, `registry` removed from all api versions (1.0-1.14) - Have added documentation for `tag` parameter and guidance on private registries for versions 1.10-1.14 (I have only validated this on .10) Docker-DCO-1.1-Signed-off-by: Lachlan Coote (github: lcoote) --- docs/sources/reference/api/docker_remote_api_v1.0.md | 6 ------ docs/sources/reference/api/docker_remote_api_v1.1.md | 6 ------ docs/sources/reference/api/docker_remote_api_v1.10.md | 11 ++++++++++- docs/sources/reference/api/docker_remote_api_v1.11.md | 11 ++++++++++- docs/sources/reference/api/docker_remote_api_v1.12.md | 11 ++++++++++- docs/sources/reference/api/docker_remote_api_v1.13.md | 11 ++++++++++- docs/sources/reference/api/docker_remote_api_v1.14.md | 11 ++++++++++- docs/sources/reference/api/docker_remote_api_v1.2.md | 6 ------ docs/sources/reference/api/docker_remote_api_v1.3.md | 6 ------ docs/sources/reference/api/docker_remote_api_v1.4.md | 6 ------ docs/sources/reference/api/docker_remote_api_v1.5.md | 6 ------ docs/sources/reference/api/docker_remote_api_v1.6.md | 6 ------ docs/sources/reference/api/docker_remote_api_v1.7.md | 6 ------ docs/sources/reference/api/docker_remote_api_v1.8.md | 6 ------ docs/sources/reference/api/docker_remote_api_v1.9.md | 6 ------ 15 files changed, 50 insertions(+), 65 deletions(-) diff --git a/docs/sources/reference/api/docker_remote_api_v1.0.md b/docs/sources/reference/api/docker_remote_api_v1.0.md index ddbc165e5e..197991de94 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.0.md +++ b/docs/sources/reference/api/docker_remote_api_v1.0.md @@ -677,12 +677,6 @@ Push the image `name` on the registry {{ STREAM }} - Query Parameters: - -   - - - **registry** – the registry you wan to push, optional - Status Codes: - **200** – no error diff --git a/docs/sources/reference/api/docker_remote_api_v1.1.md b/docs/sources/reference/api/docker_remote_api_v1.1.md index 9bffc949a6..928e3210f2 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.1.md +++ b/docs/sources/reference/api/docker_remote_api_v1.1.md @@ -687,12 +687,6 @@ Push the image `name` on the registry {"error":"Invalid..."} ... - Query Parameters: - -   - - - **registry** – the registry you wan to push, optional - Status Codes: - **200** – no error diff --git a/docs/sources/reference/api/docker_remote_api_v1.10.md b/docs/sources/reference/api/docker_remote_api_v1.10.md index e249065998..6ffae3e07e 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.10.md +++ b/docs/sources/reference/api/docker_remote_api_v1.10.md @@ -853,11 +853,20 @@ Push the image `name` on the registry {"error":"Invalid..."} ... + If you wish to push an image on to a private registry, that image must already have been tagged + into a repository which references that registry host name and port. This repository name should + then be used in the URL. This mirrors the flow of the CLI. + + **Example request**: + + POST /images/registry.acme.com:5000/test/push HTTP/1.1 + + Query Parameters:   - - **registry** – the registry you wan to push, optional + - **tag** – the tag to associate with the image on the registry, optional Request Headers: diff --git a/docs/sources/reference/api/docker_remote_api_v1.11.md b/docs/sources/reference/api/docker_remote_api_v1.11.md index 3e777f6f7a..a0187dbdf6 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.11.md +++ b/docs/sources/reference/api/docker_remote_api_v1.11.md @@ -861,11 +861,20 @@ Push the image `name` on the registry {"error":"Invalid..."} ... + If you wish to push an image on to a private registry, that image must already have been tagged + into a repository which references that registry host name and port. This repository name should + then be used in the URL. This mirrors the flow of the CLI. + + **Example request**: + + POST /images/registry.acme.com:5000/test/push HTTP/1.1 + + Query Parameters:   - - **registry** – the registry you wan to push, optional + - **tag** – the tag to associate with the image on the registry, optional Request Headers: diff --git a/docs/sources/reference/api/docker_remote_api_v1.12.md b/docs/sources/reference/api/docker_remote_api_v1.12.md index 0679b18889..54e57d2916 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.12.md +++ b/docs/sources/reference/api/docker_remote_api_v1.12.md @@ -914,11 +914,20 @@ Push the image `name` on the registry {"error":"Invalid..."} ... + If you wish to push an image on to a private registry, that image must already have been tagged + into a repository which references that registry host name and port. This repository name should + then be used in the URL. This mirrors the flow of the CLI. + + **Example request**: + + POST /images/registry.acme.com:5000/test/push HTTP/1.1 + + Query Parameters:   - - **registry** – the registry you wan to push, optional + - **tag** – the tag to associate with the image on the registry, optional Request Headers: diff --git a/docs/sources/reference/api/docker_remote_api_v1.13.md b/docs/sources/reference/api/docker_remote_api_v1.13.md index cbe013c816..cf21aefb00 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.13.md +++ b/docs/sources/reference/api/docker_remote_api_v1.13.md @@ -914,11 +914,20 @@ Push the image `name` on the registry {"error":"Invalid..."} ... + If you wish to push an image on to a private registry, that image must already have been tagged + into a repository which references that registry host name and port. This repository name should + then be used in the URL. This mirrors the flow of the CLI. + + **Example request**: + + POST /images/registry.acme.com:5000/test/push HTTP/1.1 + + Query Parameters:   - - **registry** – the registry you wan to push, optional + - **tag** – the tag to associate with the image on the registry, optional Request Headers: diff --git a/docs/sources/reference/api/docker_remote_api_v1.14.md b/docs/sources/reference/api/docker_remote_api_v1.14.md index ad842fe8a2..35f26c56df 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.14.md +++ b/docs/sources/reference/api/docker_remote_api_v1.14.md @@ -920,11 +920,20 @@ Push the image `name` on the registry {"error":"Invalid..."} ... + If you wish to push an image on to a private registry, that image must already have been tagged + into a repository which references that registry host name and port. This repository name should + then be used in the URL. This mirrors the flow of the CLI. + + **Example request**: + + POST /images/registry.acme.com:5000/test/push HTTP/1.1 + + Query Parameters:   - - **registry** – the registry you wan to push, optional + - **tag** – the tag to associate with the image on the registry, optional Request Headers: diff --git a/docs/sources/reference/api/docker_remote_api_v1.2.md b/docs/sources/reference/api/docker_remote_api_v1.2.md index 75b56ff018..2530fb90ae 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.2.md +++ b/docs/sources/reference/api/docker_remote_api_v1.2.md @@ -706,12 +706,6 @@ Push the image `name` on the registry {"error":"Invalid..."} ... - Query Parameters: - -   - - - **registry** – the registry you wan to push, optional - Status Codes: - **200** – no error diff --git a/docs/sources/reference/api/docker_remote_api_v1.3.md b/docs/sources/reference/api/docker_remote_api_v1.3.md index 9a4c79955d..ff6fcac944 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.3.md +++ b/docs/sources/reference/api/docker_remote_api_v1.3.md @@ -755,12 +755,6 @@ Push the image `name` on the registry {"error":"Invalid..."} ... - Query Parameters: - -   - - - **registry** – the registry you wan to push, optional - Status Codes: - **200** – no error diff --git a/docs/sources/reference/api/docker_remote_api_v1.4.md b/docs/sources/reference/api/docker_remote_api_v1.4.md index eac0cf3f4d..77d8e15504 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.4.md +++ b/docs/sources/reference/api/docker_remote_api_v1.4.md @@ -801,12 +801,6 @@ Push the image `name` on the registry {"status":"Pushing..."} {"status":"Pushing", "progress":"1/? (n/a)"} {"error":"Invalid..."} ... - Query Parameters: - -   - - - **registry** – the registry you wan to push, optional - Status Codes: - **200** – no error :statuscode 404: no such image :statuscode diff --git a/docs/sources/reference/api/docker_remote_api_v1.5.md b/docs/sources/reference/api/docker_remote_api_v1.5.md index 884eaae648..abf6e3397a 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.5.md +++ b/docs/sources/reference/api/docker_remote_api_v1.5.md @@ -805,12 +805,6 @@ Push the image `name` on the registry The `X-Registry-Auth` header can be used to include a base64-encoded AuthConfig object. - Query Parameters: - -   - - - **registry** – the registry you wan to push, optional - Status Codes: - **200** – no error diff --git a/docs/sources/reference/api/docker_remote_api_v1.6.md b/docs/sources/reference/api/docker_remote_api_v1.6.md index 039277fc7a..11dd45229c 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.6.md +++ b/docs/sources/reference/api/docker_remote_api_v1.6.md @@ -910,12 +910,6 @@ Push the image `name` on the registry > The `X-Registry-Auth` header can be used to > include a base64-encoded AuthConfig object. - Query Parameters: - -   - - - **registry** – the registry you wan to push, optional - Status Codes: - **200** – no error :statuscode 404: no such image :statuscode diff --git a/docs/sources/reference/api/docker_remote_api_v1.7.md b/docs/sources/reference/api/docker_remote_api_v1.7.md index 83f8176e66..10ff841799 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.7.md +++ b/docs/sources/reference/api/docker_remote_api_v1.7.md @@ -828,12 +828,6 @@ Push the image `name` on the registry {"error":"Invalid..."} ... - Query Parameters: - -   - - - **registry** – the registry you wan to push, optional - Request Headers:   diff --git a/docs/sources/reference/api/docker_remote_api_v1.8.md b/docs/sources/reference/api/docker_remote_api_v1.8.md index a252bed73e..b8bc0087c8 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.8.md +++ b/docs/sources/reference/api/docker_remote_api_v1.8.md @@ -870,12 +870,6 @@ Push the image `name` on the registry {"error":"Invalid..."} ... - Query Parameters: - -   - - - **registry** – the registry you wan to push, optional - Request Headers:   diff --git a/docs/sources/reference/api/docker_remote_api_v1.9.md b/docs/sources/reference/api/docker_remote_api_v1.9.md index 529699d488..38f4ca8f54 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.9.md +++ b/docs/sources/reference/api/docker_remote_api_v1.9.md @@ -874,12 +874,6 @@ Push the image `name` on the registry {"error":"Invalid..."} ... - Query Parameters: - -   - - - **registry** – the registry you wan to push, optional - Request Headers: