TrueCloudLab/distribution
13
0
Fork 3
Code Issues 3 Pull requests Projects Releases 2 Packages Wiki Activity Actions

Merge pull request #368 from dmcgowan/upload-api-docs-update

Browse source 
Update final upload chunk api doc
This commit is contained in:
Stephen Day 2015-04-15 19:09:00 -07:00
commit e16c23bb43
3 changed files with 9 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Makefile
View file

@ -28,7 +28,7 @@ ${PREFIX}/bin/dist: version/version.go $(shell find . -type f -name '*.go')
@echo "+ $@" @echo "+ $@"
@go build -o $@ ${GO_LDFLAGS} ./cmd/dist @go build -o $@ ${GO_LDFLAGS} ./cmd/dist
doc/spec/api.md: doc/spec/api.md.tmpl ${PREFIX}/bin/registry-api-descriptor-template docs/spec/api.md: docs/spec/api.md.tmpl ${PREFIX}/bin/registry-api-descriptor-template
./bin/registry-api-descriptor-template $< > $@ ./bin/registry-api-descriptor-template $< > $@
vet: vet:

6
docs/spec/api.md
View file

@ -2375,7 +2375,7 @@ The following parameters should be specified on the request:
204 No Content 204 No Content
Location: <blob location> Location: <blob location>
Content-Range: <start of range>-<end of range, inclusive> Content-Range: <start of range>-<end of range, inclusive>
Content-Length: <length of chunk> Content-Length: 0
Docker-Content-Digest: <digest> Docker-Content-Digest: <digest>
``` ```
@ -2385,9 +2385,9 @@ The following headers will be returned with the response:
|Name|Description| |Name|Description|
|----|-----------| |----|-----------|
|`Location`|| |`Location`|The canonical location of the blob for retrieval|
|`Content-Range`|Range of bytes identifying the desired block of content represented by the body. Start must match the end of offset retrieved via status check. Note that this is a non-standard use of the `Content-Range` header.| |`Content-Range`|Range of bytes identifying the desired block of content represented by the body. Start must match the end of offset retrieved via status check. Note that this is a non-standard use of the `Content-Range` header.|
|`Content-Length`|Length of the chunk being uploaded, corresponding the length of the request body.| |`Content-Length`|The `Content-Length` header must be zero and the body must be empty.|
|`Docker-Content-Digest`|Digest of the targeted content for the request.| |`Docker-Content-Digest`|Digest of the targeted content for the request.|

14
registry/api/v2/descriptors.go
View file

@ -1190,9 +1190,10 @@ var routeDescriptors = []RouteDescriptor{
StatusCode: http.StatusNoContent, StatusCode: http.StatusNoContent,
Headers: []ParameterDescriptor{ Headers: []ParameterDescriptor{
{ {
Name: "Location", Name: "Location",
Type: "url", Type: "url",
Format: "<blob location>", Format: "<blob location>",
Description: "The canonical location of the blob for retrieval",
}, },
{ {
Name: "Content-Range", Name: "Content-Range",
@ -1200,12 +1201,7 @@ var routeDescriptors = []RouteDescriptor{
Format: "<start of range>-<end of range, inclusive>", Format: "<start of range>-<end of range, inclusive>",
Description: "Range of bytes identifying the desired block of content represented by the body. Start must match the end of offset retrieved via status check. Note that this is a non-standard use of the `Content-Range` header.", Description: "Range of bytes identifying the desired block of content represented by the body. Start must match the end of offset retrieved via status check. Note that this is a non-standard use of the `Content-Range` header.",
}, },
{ contentLengthZeroHeader,
Name: "Content-Length",
Type: "integer",
Format: "<length of chunk>",
Description: "Length of the chunk being uploaded, corresponding the length of the request body.",
},
digestHeader, digestHeader,
}, },
}, },