registry: add reference #22497
registry: add reference #22497
Conversation
github-actions
bot
added
area/compose
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: Craig <craig.osterhout@docker.com>
Signed-off-by: Craig <craig.osterhout@docker.com>
craig-osterhout
force-pushed
the
engdocs-2577
branch
from
77e8a7e to
410cb85
Compare
content/reference/drivers-and-specifications/token-authorization/token.md
Outdated
Show resolved
Hide resolved
craig-osterhout
added
status/review
and removed
area/compose
There was a problem hiding this comment.
the black lines are really hard to see on dark mode in the docs site
There was a problem hiding this comment.
Just curious, is there a reason we aren’t using an OpenAPI spec to generate this documentation? It might help reduce complexity, ensure consistency, and make it easier to integrate with Redocly like the other references are
There was a problem hiding this comment.
So the reason why this is separate from Docker Hub API
The API's documented there are API's specific to "Hub" - organizations, access tokens, etc.
These API's are Registry specific API's that are applicable to the OCI Distribution project that we forked. But not all of the API's from the project are enabled in our version so this is documenting the ones that are.
There was a problem hiding this comment.
Regarding using OpenAPI spec, this PR is a minimum-effort change to quickly reintroduce previously existing content that was already in Markdown. Migrating it to OpenAPI in a followup PR would definitely be nice. Even the existing Markdown content could use some cleanup. My main goal here was to update it just enough to get it through the build checks for now, and then iterate.
| @@ -0,0 +1,1552 @@ | |||
| --- | |||
| title: Docker Registry HTTP API V2 | |||
There was a problem hiding this comment.
This API is obsolete, and replaced by the OCI distribution spec; is there a reason we want to duplicate the specification?
There was a problem hiding this comment.
Not all of the spec endpoints are supported by us. We are just providing documentation of the OCI endpoints that are supported with our version of distribution.
There was a problem hiding this comment.
Maybe we can rename this so it doesn't get confused as being the main spec? I'm not familiar enough, but maybe something like Supported Docker Registry API for Docker Hub (still keep the linktitle as Registry API though.)
Description
Re-add registry reference from point in time of deletion at #18390, not upstream.
Related issues or tickets
ENGDOCS-2577
Reviews