Skip to content

Commit 620c621

Browse files
committed
spec: catalog operations optional.
This commit redefines the `_catalog` endpoint as an optional operation. Background on the issue: opencontainers#22 https://groups.google.com/a/opencontainers.org/forum/#!topic/dev/rJ72OtZuhbc opencontainers/tob#35 opencontainers/tob#46 opencontainers/tob#50 Signed-off-by: Atlas Kerr <[email protected]>
1 parent 0a02fd5 commit 620c621

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

spec.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -718,7 +718,8 @@ Content-Type: application/json
718718
}
719719
```
720720

721-
Note that the contents of the response are specific to the registry implementation.
721+
Note that catalog operations are optional for registry implementations.
722+
Contents of the response are specific to the registry implementation.
722723
Some registries may opt to provide a full catalog output, limit it based on the user's access level or omit upstream results, if providing mirroring functionality.
723724
Subsequently, the presence of a repository in the catalog listing only means that the registry *may* provide access to the repository at the time of the request.
724725
Conversely, a missing entry does *not* mean that the registry does not have the repository.
@@ -911,7 +912,7 @@ A list of methods and URIs are covered in the table below:
911912
| PATCH | `/v2/<name>/blobs/uploads/<uuid>` | Blob Upload | Upload a chunk of data for the specified upload. |
912913
| PUT | `/v2/<name>/blobs/uploads/<uuid>` | Blob Upload | Complete the upload specified by `uuid`, optionally appending the body as the final chunk. |
913914
| DELETE | `/v2/<name>/blobs/uploads/<uuid>` | Blob Upload | Cancel outstanding upload processes, releasing associated resources. If this is not called, the unfinished uploads will eventually timeout. |
914-
| GET | `/v2/_catalog` | Catalog | Retrieve a sorted, json list of repositories available in the registry. |
915+
| GET | `/v2/_catalog` | Catalog | (OPTIONAL) Retrieve a sorted, json list of repositories available in the registry. |
915916

916917
The detail for each endpoint is covered in the following sections.
917918

@@ -4643,7 +4644,7 @@ The error codes that may be included in the response body are enumerated below:
46434644
|-------------------|-------------------|---------------------------------------------------------------------|
46444645
| `TOOMANYREQUESTS` | too many requests | Returned when a client attempts to contact a service too many times |
46454646

4646-
### Catalog
4647+
### Catalog (OPTIONAL)
46474648

46484649
List a set of available repositories in the local registry cluster.
46494650
Does not provide any indication of what may be available upstream.

0 commit comments

Comments
 (0)