Skip to content

Remove "reference" from spec - #616

Merged
dmcgowan merged 1 commit into
opencontainers:mainfrom
sudo-bmitch:pr-identifier
Jul 16, 2026
Merged

Remove "reference" from spec#616
dmcgowan merged 1 commit into
opencontainers:mainfrom
sudo-bmitch:pr-identifier

Conversation

@sudo-bmitch

@sudo-bmitch sudo-bmitch commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

There were two places the term "reference" was used:

  1. As the "tag or digest" parameter in the manifest endpoints. This was changed to "tag-or-digest".
  2. As the returned location to upload blobs in our endpoints table. This was changed to "blob-push-location", and then usage of "location" earlier in the spec were updated for consistency.

This change removes confusion with the "reference" term in the OCI ecosystem where it is a string that identifies an image, including the registry, repository, and identifier. For context, see https://github.com/distribution/reference.

Fixes #216.

@mikebrow mikebrow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thoughts?

Comment thread spec.md Outdated
Comment thread spec.md Outdated
Comment thread spec.md Outdated
There were two places the term reference was used:

1. As the "tag or digest" parameter in the manifest endpoints. This was changed to "tag-or-digest".
2. As the returned location to upload blobs. This was changed to "blob-push-location".

This change removes confusion with the "reference" term in the OCI ecosystem that represents that string that identifies an image, including the registry, repository, and identifier.
For context, see https://github.com/distribution/reference.

Signed-off-by: Brandon Mitchell <git@bmitch.net>
@sudo-bmitch sudo-bmitch changed the title Change "reference" to "identifier" Remove "reference" from spec Jul 9, 2026
@sudo-bmitch

Copy link
Copy Markdown
Contributor Author

This has been updated with the discussion in #216 to use <tag-or-digest> for the previous usage of <reference> in the manifest endpoints.

@mikebrow mikebrow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment thread spec.md
`<name>` refers to the namespace of the repository.
`<reference>` MUST be either (a) the digest of the manifest or (b) a tag.
The `<reference>` MUST NOT be in any other format.
`<tag-or-digest>` MUST be either (a) the digest of the manifest or (b) a tag.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I kind of love that these are in the opposite order; "<tag-or-digest> must be .. a digest or a tag" 😂

@dmcgowan
dmcgowan merged commit 967efdc into opencontainers:main Jul 16, 2026
4 checks passed
@sudo-bmitch
sudo-bmitch deleted the pr-identifier branch July 16, 2026 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improving usage of reference terminology

4 participants