vbatts/registry
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Add documentation for client version header

Browse source 
Add documentation for Docker-Distribution-API-Version header required by clients

closes #99

Signed-off-by: Derek McGowan <derek@mcgstyle.net> (github: dmcgowan)
This commit is contained in:
Derek McGowan 2015-05-06 15:44:24 -07:00 committed by Richard
parent b5b69a053b
commit 6fc30199fe
2 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/spec/api.md
View file

@ -233,6 +233,11 @@ If `404 Not Found` response status, or other unexpected status, is returned,
the client should proceed with the assumption that the registry does not the client should proceed with the assumption that the registry does not
implement V2 of the API. implement V2 of the API.
When a `200 OK` or `401 Unauthorized` response is returned, the
"Docker-Distribution-API-Version" header should be set to "registry/2.0".
Clients may require this header value to determine if the endpoint serves this
API. When this header is omitted, clients may fallback to an older API version.
### Pulling An Image ### Pulling An Image
An "image" is a combination of a JSON manifest and individual layer files. The An "image" is a combination of a JSON manifest and individual layer files. The

5
docs/spec/api.md.tmpl
View file

@ -233,6 +233,11 @@ If `404 Not Found` response status, or other unexpected status, is returned,
the client should proceed with the assumption that the registry does not the client should proceed with the assumption that the registry does not
implement V2 of the API. implement V2 of the API.
When a `200 OK` or `401 Unauthorized` response is returned, the
"Docker-Distribution-API-Version" header should be set to "registry/2.0".
Clients may require this header value to determine if the endpoint serves this
API. When this header is omitted, clients may fallback to an older API version.
### Pulling An Image ### Pulling An Image
An "image" is a combination of a JSON manifest and individual layer files. The An "image" is a combination of a JSON manifest and individual layer files. The