Skip to content

Commit

Permalink
spec: clarify referrers response for index
Browse files Browse the repository at this point in the history
Signed-off-by: Sajay Antony <sajaya@microsoft.com>
  • Loading branch information
sajayantony committed Dec 22, 2023
1 parent 6bc8715 commit 9989b6a
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -556,10 +556,11 @@ If the request is invalid, such as a `<digest>` with an invalid syntax, a `400 B

Upon success, the response MUST be a JSON body with an image index containing a list of descriptors.
The `Content-Type` header MUST be set to `application/vnd.oci.image.index.v1+json`.
Each descriptor is of an image manifest in the same `<name>` namespace with a `subject` field that specifies the value of `<digest>`.
The descriptors MUST include an `artifactType` field that is set to the value of the `artifactType` in the image manifest, if present.
Each descriptor is of an image manifest or index in the same `<name>` namespace with a `subject` field that specifies the value of `<digest>`.
The descriptors MUST include an `artifactType` field that is set to the value of the `artifactType` in the image manifest or index, if present.
If the `artifactType` is empty or missing in the image manifest, the value of `artifactType` MUST be set to the config descriptor `mediaType` value.
The descriptors MUST include annotations from the image manifest.
If the `artifactType` is empty or missing in an index, the `artifactType` MUST be omitted.
The descriptors MUST include annotations from the image manifest or index.
If a query results in no matching referrers, an empty manifest list MUST be returned.
If a manifest with the digest `<digest>` does not exist, a registry MAY return an empty manifest list.
After a manifest with the digest `<digest>` is pushed, the registry MUST include previously pushed entries in the referrers list.
Expand All @@ -575,7 +576,7 @@ After a manifest with the digest `<digest>` is pushed, the registry MUST include
"digest": "sha256:a1a1a1...",
"artifactType": "application/vnd.example.sbom.v1",
"annotations": {
"org.opencontainers.artifact.created": "2022-01-01T14:42:55Z",
"org.opencontainers.image.created": "2022-01-01T14:42:55Z",
"org.example.sbom.format": "json"
}
},
Expand All @@ -585,9 +586,17 @@ After a manifest with the digest `<digest>` is pushed, the registry MUST include
"digest": "sha256:a2a2a2...",
"artifactType": "application/vnd.example.signature.v1",
"annotations": {
"org.opencontainers.artifact.created": "2022-01-01T07:21:33Z",
"org.opencontainers.image.created": "2022-01-01T07:21:33Z",
"org.example.signature.fingerprint": "abcd"
}
},
{
"mediaType": "application/vnd.oci.image.index.v1+json",
"size": 1234,
"digest": "sha256:a3a3a3...",
"annotations": {
"org.opencontainers.image.created": "2023-01-01T07:21:33Z",
}
}
]
}
Expand Down

0 comments on commit 9989b6a

Please sign in to comment.