From 7b3f571555dcbfe756a55340df196fbae9fe6d6f Mon Sep 17 00:00:00 2001 From: Vincent Giersch Date: Mon, 1 Jun 2015 15:14:03 +0000 Subject: [PATCH] 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 --- docs/spec/api.md | 6 +++--- registry/api/v2/descriptors.go | 12 ++++++------ 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/spec/api.md b/docs/spec/api.md index 7993b354e..15eba43bf 100644 --- a/docs/spec/api.md +++ b/docs/spec/api.md @@ -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.| |`Authorization`|header|An RFC7235 compliant authorization header.| |`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.| |`Authorization`|header|An RFC7235 compliant authorization header.| |`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.| |`Authorization`|header|An RFC7235 compliant authorization header.| |`name`|path|Name of the target repository.| -|`tag`|path|Tag of the target manifiest.| +|`reference`|path|Tag or digest of the target manifest.| diff --git a/registry/api/v2/descriptors.go b/registry/api/v2/descriptors.go index d7c4a880c..e08c1324c 100644 --- a/registry/api/v2/descriptors.go +++ b/registry/api/v2/descriptors.go @@ -16,12 +16,12 @@ var ( Description: `Name of the target repository.`, } - tagParameterDescriptor = ParameterDescriptor{ - Name: "tag", + referenceParameterDescriptor = ParameterDescriptor{ + Name: "reference", Type: "string", Format: TagNameRegexp.String(), Required: true, - Description: `Tag of the target manifiest.`, + Description: `Tag or digest of the target manifest.`, } uuidParameterDescriptor = ParameterDescriptor{ @@ -476,7 +476,7 @@ var routeDescriptors = []RouteDescriptor{ }, PathParameters: []ParameterDescriptor{ nameParameterDescriptor, - tagParameterDescriptor, + referenceParameterDescriptor, }, Successes: []ResponseDescriptor{ { @@ -542,7 +542,7 @@ var routeDescriptors = []RouteDescriptor{ }, PathParameters: []ParameterDescriptor{ nameParameterDescriptor, - tagParameterDescriptor, + referenceParameterDescriptor, }, Body: BodyDescriptor{ ContentType: "application/json; charset=utf-8", @@ -648,7 +648,7 @@ var routeDescriptors = []RouteDescriptor{ }, PathParameters: []ParameterDescriptor{ nameParameterDescriptor, - tagParameterDescriptor, + referenceParameterDescriptor, }, Successes: []ResponseDescriptor{ {