From d06de5227af77a0f1000aba7f0d9aae4768f8c8c Mon Sep 17 00:00:00 2001 From: Jason Hall Date: Thu, 2 Feb 2023 11:06:22 -0500 Subject: [PATCH] Specify filters-applied response header Signed-off-by: Jason Hall --- spec.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/spec.md b/spec.md index c306aa11..7814e99e 100644 --- a/spec.md +++ b/spec.md @@ -568,7 +568,7 @@ The `Link` header MUST be set according to [RFC5988](https://www.rfc-editor.org/ The registry SHOULD support filtering on `artifactType`. To fetch the list of referrers with a filter, perform a `GET` request to a path in the following format: `/v2//referrers/?artifactType=` [end-12b](#endpoints). -If filtering is requested and applied, the response MUST include an annotation (`org.opencontainers.referrers.filtersApplied`) denoting that an `artifactType` filter was applied. +If filtering is requested and applied, the response MUST include a header `OCI-Filters-Applied: artifactType` denoting that an `artifactType` filter was applied. If multiple filters are applied, the annotation MUST contain a comma separated list of applied filters. Example request with filtering: @@ -580,6 +580,7 @@ GET /v2//referrers/?artifactType=application/vnd.example.sbom.v1 Example response with filtering: ```json +OCI-Filters-Applied: artifactType { "schemaVersion": 2, "mediaType": "application/vnd.oci.image.index.v1+json", @@ -595,9 +596,6 @@ Example response with filtering: } } ], - "annotations": { - "org.opencontainers.referrers.filtersApplied": "artifactType" - } } ```