alexvanin/distribution
1
0
Fork 0
forked from TrueCloudLab/distribution
Code Pull requests Activity

doc: coherence between requests and parameters + typo

Browse source 
In the request parameters lists `tag` was used instead of
`reference` present in the HTTP requests paths

Signed-off-by: Vincent Giersch <vincent.giersch@ovh.net>
This commit is contained in:
Vincent Giersch 2015-06-01 15:14:03 +00:00
parent cd7d977fe6
commit 7b3f571555
2 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/spec/api.md
View file

@ -992,7 +992,7 @@ The following parameters should be specified on the request:
|`Host`|header|Standard HTTP Host Header. Should be set to the registry host.| |`Host`|header|Standard HTTP Host Header. Should be set to the registry host.|
|`Authorization`|header|An RFC7235 compliant authorization header.| |`Authorization`|header|An RFC7235 compliant authorization header.|
|`name`|path|Name of the target repository.| |`name`|path|Name of the target repository.|
|`tag`|path|Tag of the target manifiest.| |`reference`|path|Tag or digest of the target manifest.|
@ -1160,7 +1160,7 @@ The following parameters should be specified on the request:
|`Host`|header|Standard HTTP Host Header. Should be set to the registry host.| |`Host`|header|Standard HTTP Host Header. Should be set to the registry host.|
|`Authorization`|header|An RFC7235 compliant authorization header.| |`Authorization`|header|An RFC7235 compliant authorization header.|
|`name`|path|Name of the target repository.| |`name`|path|Name of the target repository.|
|`tag`|path|Tag of the target manifiest.| |`reference`|path|Tag or digest of the target manifest.|
@ -1344,7 +1344,7 @@ The following parameters should be specified on the request:
|`Host`|header|Standard HTTP Host Header. Should be set to the registry host.| |`Host`|header|Standard HTTP Host Header. Should be set to the registry host.|
|`Authorization`|header|An RFC7235 compliant authorization header.| |`Authorization`|header|An RFC7235 compliant authorization header.|
|`name`|path|Name of the target repository.| |`name`|path|Name of the target repository.|
|`tag`|path|Tag of the target manifiest.| |`reference`|path|Tag or digest of the target manifest.|

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

@ -16,12 +16,12 @@ var (
Description: `Name of the target repository.`, Description: `Name of the target repository.`,
} }
tagParameterDescriptor = ParameterDescriptor{ referenceParameterDescriptor = ParameterDescriptor{
Name: "tag", Name: "reference",
Type: "string", Type: "string",
Format: TagNameRegexp.String(), Format: TagNameRegexp.String(),
Required: true, Required: true,
Description: `Tag of the target manifiest.`, Description: `Tag or digest of the target manifest.`,
} }
uuidParameterDescriptor = ParameterDescriptor{ uuidParameterDescriptor = ParameterDescriptor{
@ -476,7 +476,7 @@ var routeDescriptors = []RouteDescriptor{
}, },
PathParameters: []ParameterDescriptor{ PathParameters: []ParameterDescriptor{
nameParameterDescriptor, nameParameterDescriptor,
tagParameterDescriptor, referenceParameterDescriptor,
}, },
Successes: []ResponseDescriptor{ Successes: []ResponseDescriptor{
{ {
@ -542,7 +542,7 @@ var routeDescriptors = []RouteDescriptor{
}, },
PathParameters: []ParameterDescriptor{ PathParameters: []ParameterDescriptor{
nameParameterDescriptor, nameParameterDescriptor,
tagParameterDescriptor, referenceParameterDescriptor,
}, },
Body: BodyDescriptor{ Body: BodyDescriptor{
ContentType: "application/json; charset=utf-8", ContentType: "application/json; charset=utf-8",
@ -648,7 +648,7 @@ var routeDescriptors = []RouteDescriptor{
}, },
PathParameters: []ParameterDescriptor{ PathParameters: []ParameterDescriptor{
nameParameterDescriptor, nameParameterDescriptor,
tagParameterDescriptor, referenceParameterDescriptor,
}, },
Successes: []ResponseDescriptor{ Successes: []ResponseDescriptor{
{ {