Skip to content

Commit b6f40f8

Browse files
authored
Merge pull request opencontainers#2 from sudo-bmitch/playground-pr
Update API response, remove paging limits
2 parents fdb53f8 + 4a90d45 commit b6f40f8

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

spec.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -492,6 +492,7 @@ Assuming a repository is found, this request MUST return a `200 OK` response cod
492492
If a query results in no referrers found, an empty manifest list MUST be returned.
493493

494494
Upon success, the response MUST be a json body in the following format (an index / manifest list):
495+
495496
```json
496497
{
497498
"schemaVersion": 2,
@@ -500,25 +501,27 @@ Upon success, the response MUST be a json body in the following format (an index
500501
{
501502
"mediaType": "application/vnd.oci.image.manifest.v1+json",
502503
"size": 1234,
503-
"digest": "sha256:a1a1a1..."
504+
"digest": "sha256:a1a1a1...",
505+
"artifactType": "application/vnd.example.sbom.v1",
506+
"annotations": {
507+
"org.opencontainers.artifact.created": "2022-01-01T14:42:55Z",
508+
"org.example.sbom.format": "json"
509+
}
504510
},
505511
{
506512
"mediaType": "application/vnd.oci.artifact.manifest.v1+json",
507-
"artifactType": "image/png",
508-
"digest": "sha256:a2a2a2..."
513+
"size": 1234,
514+
"digest": "sha256:a2a2a2...",
515+
"artifactType": "application/vnd.example.signature.v1",
516+
"annotations": {
517+
"org.opencontainers.artifact.created": "2022-01-01T07:21:33Z",
518+
"org.example.signature.fingerprint": "abcd"
519+
}
509520
}
510521
]
511522
}
512523
```
513524

514-
In addition to fetching the whole list of referrers, a subset of the referrers can be fetched by providing the `n` query parameter.
515-
In this case, the path will look like the following: `/v2/<name>/referrers/<reference>?n=<int>` <sup>[end-12b](#endpoints)</sup>
516-
517-
`<name>` is the namespace of the repository, and `<int>` is an integer specifying the number of referrers requested.
518-
The response to such a request MAY return fewer than `<int>` results, but only when the total number of referrers is less than `<int>`.
519-
Otherwise, the response MUST include `<int>` results.
520-
When `n` is zero, this endpoint MUST return an empty manifest list, and MUST NOT include a `Link` header.
521-
522525
A `Link` header MUST be included in the response when additional results are available, and it MUST be
523526
set to the URL for the next page of results.
524527

0 commit comments

Comments
 (0)