ソースを参照

#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 <lachlan.t.coote@gmail.com> (github: lcoote)
Lachlan Coote 11 年 前
コミット
a5c5dc121c

+ 0 - 6
docs/sources/reference/api/docker_remote_api_v1.0.md

@@ -677,12 +677,6 @@ Push the image `name` on the registry
 
 
         {{ STREAM }}
         {{ STREAM }}
 
 
-    Query Parameters:
-
-     
-
-    -   **registry** – the registry you wan to push, optional
-
     Status Codes:
     Status Codes:
 
 
     -   **200** – no error
     -   **200** – no error

+ 0 - 6
docs/sources/reference/api/docker_remote_api_v1.1.md

@@ -687,12 +687,6 @@ Push the image `name` on the registry
         {"error":"Invalid..."}
         {"error":"Invalid..."}
         ...
         ...
 
 
-    Query Parameters:
-
-     
-
-    -   **registry** – the registry you wan to push, optional
-
     Status Codes:
     Status Codes:
 
 
     -   **200** – no error
     -   **200** – no error

+ 10 - 1
docs/sources/reference/api/docker_remote_api_v1.10.md

@@ -853,11 +853,20 @@ Push the image `name` on the registry
         {"error":"Invalid..."}
         {"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:
     Query Parameters:
 
 
      
      
 
 
-    -   **registry** – the registry you wan to push, optional
+    -   **tag** – the tag to associate with the image on the registry, optional
 
 
     Request Headers:
     Request Headers:
 
 

+ 10 - 1
docs/sources/reference/api/docker_remote_api_v1.11.md

@@ -861,11 +861,20 @@ Push the image `name` on the registry
         {"error":"Invalid..."}
         {"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:
     Query Parameters:
 
 
      
      
 
 
-    -   **registry** – the registry you wan to push, optional
+    -   **tag** – the tag to associate with the image on the registry, optional
 
 
     Request Headers:
     Request Headers:
 
 

+ 10 - 1
docs/sources/reference/api/docker_remote_api_v1.12.md

@@ -914,11 +914,20 @@ Push the image `name` on the registry
         {"error":"Invalid..."}
         {"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:
     Query Parameters:
 
 
      
      
 
 
-    -   **registry** – the registry you wan to push, optional
+    -   **tag** – the tag to associate with the image on the registry, optional
 
 
     Request Headers:
     Request Headers:
 
 

+ 10 - 1
docs/sources/reference/api/docker_remote_api_v1.13.md

@@ -914,11 +914,20 @@ Push the image `name` on the registry
         {"error":"Invalid..."}
         {"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:
     Query Parameters:
 
 
      
      
 
 
-    -   **registry** – the registry you wan to push, optional
+    -   **tag** – the tag to associate with the image on the registry, optional
 
 
     Request Headers:
     Request Headers:
 
 

+ 10 - 1
docs/sources/reference/api/docker_remote_api_v1.14.md

@@ -920,11 +920,20 @@ Push the image `name` on the registry
         {"error":"Invalid..."}
         {"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:
     Query Parameters:
 
 
      
      
 
 
-    -   **registry** – the registry you wan to push, optional
+    -   **tag** – the tag to associate with the image on the registry, optional
 
 
     Request Headers:
     Request Headers:
 
 

+ 0 - 6
docs/sources/reference/api/docker_remote_api_v1.2.md

@@ -706,12 +706,6 @@ Push the image `name` on the registry
         {"error":"Invalid..."}
         {"error":"Invalid..."}
         ...
         ...
 
 
-    Query Parameters:
-
-     
-
-    -   **registry** – the registry you wan to push, optional
-
     Status Codes:
     Status Codes:
 
 
     -   **200** – no error
     -   **200** – no error

+ 0 - 6
docs/sources/reference/api/docker_remote_api_v1.3.md

@@ -755,12 +755,6 @@ Push the image `name` on the registry
         {"error":"Invalid..."}
         {"error":"Invalid..."}
         ...
         ...
 
 
-    Query Parameters:
-
-     
-
-    -   **registry** – the registry you wan to push, optional
-
     Status Codes:
     Status Codes:
 
 
     -   **200** – no error
     -   **200** – no error

+ 0 - 6
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)"}
     {"status":"Pushing..."} {"status":"Pushing", "progress":"1/? (n/a)"}
     {"error":"Invalid..."} ...
     {"error":"Invalid..."} ...
 
 
-    Query Parameters:
-
-     
-
-    -   **registry** – the registry you wan to push, optional
-
     Status Codes:
     Status Codes:
 
 
     -   **200** – no error :statuscode 404: no such image :statuscode
     -   **200** – no error :statuscode 404: no such image :statuscode

+ 0 - 6
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
     The `X-Registry-Auth` header can be used to
     include a base64-encoded AuthConfig object.
     include a base64-encoded AuthConfig object.
 
 
-    Query Parameters:
-
-     
-
-    -   **registry** – the registry you wan to push, optional
-
     Status Codes:
     Status Codes:
 
 
     -   **200** – no error
     -   **200** – no error

+ 0 - 6
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
     > The `X-Registry-Auth` header can be used to
     > include a base64-encoded AuthConfig object.
     > include a base64-encoded AuthConfig object.
 
 
-    Query Parameters:
-
-     
-
-    -   **registry** – the registry you wan to push, optional
-
     Status Codes:
     Status Codes:
 
 
     -   **200** – no error :statuscode 404: no such image :statuscode
     -   **200** – no error :statuscode 404: no such image :statuscode

+ 0 - 6
docs/sources/reference/api/docker_remote_api_v1.7.md

@@ -828,12 +828,6 @@ Push the image `name` on the registry
         {"error":"Invalid..."}
         {"error":"Invalid..."}
         ...
         ...
 
 
-    Query Parameters:
-
-     
-
-    -   **registry** – the registry you wan to push, optional
-
     Request Headers:
     Request Headers:
 
 
      
      

+ 0 - 6
docs/sources/reference/api/docker_remote_api_v1.8.md

@@ -870,12 +870,6 @@ Push the image `name` on the registry
         {"error":"Invalid..."}
         {"error":"Invalid..."}
         ...
         ...
 
 
-    Query Parameters:
-
-     
-
-    -   **registry** – the registry you wan to push, optional
-
     Request Headers:
     Request Headers:
 
 
      
      

+ 0 - 6
docs/sources/reference/api/docker_remote_api_v1.9.md

@@ -874,12 +874,6 @@ Push the image `name` on the registry
         {"error":"Invalid..."}
         {"error":"Invalid..."}
         ...
         ...
 
 
-    Query Parameters:
-
-     
-
-    -   **registry** – the registry you wan to push, optional
-
     Request Headers:
     Request Headers: