From 352924cd854d83024a71d42c7893bc873a156485 Mon Sep 17 00:00:00 2001 From: Richard Scothern Date: Wed, 8 Jun 2016 10:39:17 -0700 Subject: [PATCH] Clarify API documentation around catalog fetch behavior Signed-off-by: Richard Scothern --- docs/spec/api.md | 4 ++-- registry/api/v2/descriptors.go | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/spec/api.md b/docs/spec/api.md index aeb6bee9..39041146 100644 --- a/docs/spec/api.md +++ b/docs/spec/api.md @@ -4765,13 +4765,13 @@ List a set of available repositories in the local registry cluster. Does not pro Retrieve a sorted, json list of repositories available in the registry. -##### Catalog Fetch Complete +##### Catalog Fetch ``` GET /v2/_catalog ``` -Request an unabridged list of repositories available. +Request an unabridged list of repositories available. The implementation may impose a maximum limit and return a partial set with pagination links. diff --git a/registry/api/v2/descriptors.go b/registry/api/v2/descriptors.go index 58279994..fc42c1c4 100644 --- a/registry/api/v2/descriptors.go +++ b/registry/api/v2/descriptors.go @@ -1497,8 +1497,8 @@ var routeDescriptors = []RouteDescriptor{ Description: "Retrieve a sorted, json list of repositories available in the registry.", Requests: []RequestDescriptor{ { - Name: "Catalog Fetch Complete", - Description: "Request an unabridged list of repositories available.", + Name: "Catalog Fetch", + Description: "Request an unabridged list of repositories available. The implementation may impose a maximum limit and return a partial set with pagination links.", Successes: []ResponseDescriptor{ { Description: "Returns the unabridged list of repositories as a json response.",