1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00

#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)
This commit is contained in:
Lachlan Coote 2014-07-31 19:26:32 -07:00 committed by unknown
parent ca602cd1e5
commit a5c5dc121c
15 changed files with 50 additions and 65 deletions

View file

@ -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

View file

@ -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

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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:

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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:
 

View file

@ -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:
 

View file

@ -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: