Skip to content

Commit 8572103

Browse files
sudo-bmitchjdolitsky
authored andcommitted
Markdown nits
Signed-off-by: Brandon Mitchell <[email protected]>
1 parent a0d8014 commit 8572103

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

client-implementation.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ This section describes how client fallback procedures when an API is not availab
1111

1212
The Referrers API here is described by [Listing Referrers](spec.md#listing-referrers) and [end-12](spec.md#endpoints).
1313

14-
A client that pushing an Image or Artifact manifest with a defined `Refers` field MUST verify the Referrers API is available.
14+
A client that pushes an Image or Artifact manifest with a defined `Refers` field MUST verify the Referrers API is available.
1515
A client querying the Referrers API and receiving a 404 MUST fallback to using an Index pushed to a tag described by the following schema.
1616

17-
**Tag Schema**
17+
#### Referrers Tag Schema
1818

1919
```text
2020
<alg>-<ref>
@@ -25,7 +25,7 @@ A client querying the Referrers API and receiving a 404 MUST fallback to using a
2525

2626
For example, a manifest with the `Refers` field digest set to `sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa` in the `registry.example.org/project` repository would have a expect an Index at `registry.example.org/project:sha256-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`
2727

28-
**Pushing Manifests**
28+
#### Pushing Manifests with Refers
2929

3030
When pushing an Image or Artifact manifest with the `Refers` field and the Referrers API returns a 404, the client MUST:
3131

@@ -39,13 +39,13 @@ When pushing an Image or Artifact manifest with the `Refers` field and the Refer
3939
1. Push the updated Index using the same tag schema.
4040
The client MAY use conditional HTTP requests to prevent overwriting an Index that has changed since it was first pulled.
4141

42-
**Listing Referrers**
42+
#### Listing Referrers
4343

4444
If the Referrers API returns a 404, the client MUST fallback to pulling the tag schema.
4545
The response SHOULD be an Index with the same content that would be expected from the Referrers API.
4646
If the response to the Referrers API is a 404, and the tag schema does not return a valid Index, the client SHOULD assume there are no Referrers to the manifest.
4747

48-
**Deleting Referrers**
48+
#### Deleting Referrers
4949

5050
When deleting an Image or Artifact manifest that contains a `Refers` field, and the Referrers API returns a 404, clients SHOULD:
5151

@@ -54,11 +54,11 @@ When deleting an Image or Artifact manifest that contains a `Refers` field, and
5454
1. Push the updated Index using the same tag schema.
5555
The client MAY use conditional HTTP requests to prevent overwriting an Index that has changed since it was first pulled.
5656

57-
**Deleting Manifests**
57+
#### Deleting Manifests with Referrers
5858

5959
Clients MAY delete a tag using the tag schema when it returns a valid Index manifest and the referred manifest has been deleted.
6060

61-
**Recommendations**
61+
#### Referrers API Recommendations
6262

6363
- Clients MAY verify the registry does not support the referrers API by querying the API and checking for a 404.
6464
- When the Referrers API is not available, clients MAY perform periodic garbage collection of stale tag schema tags and descriptors in the Index manifest list that no longer exist.

0 commit comments

Comments
 (0)