daniel
/
distribution
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: coherence between requests and parameters + typo 

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>
master
Vincent Giersch 2015-06-01 15:14:03 +00:00
parent c703b9318e
commit 040d7038b8
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/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{
{ {