[docker-hub-api] add list namespace repositories endpoint #22934
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| ### New | ||
|
|
||
| - Add [List repositories](/reference/api/hub/latest/#tag/repositories/operation/listNamespaceRepositories) endpoints for a given `namespace`. | ||
| - Deprecate undocumented endpoint `GET /v2/repositories/{namespace}` replaced by [List repositories](/reference/api/hub/latest/#tag/repositories/operation/listNamespaceRepositories). |
There was a problem hiding this comment.
Not sure what we did in the past, but perhaps for visibility (although there’s only 2 things in the bullets), we could use ### New for the new endpoint, and a ### Deprecations (or similar) for what’s deprecated. That could also add a link to the “deprecated” page (refer to “deprecated” for a list of deprecated API endpoints / API features)
There was a problem hiding this comment.
Probably also want to add a mention in deprecated; not sure if we have a good format for that already, but there’s some existing things that were deprecated; https://github.com/docker/docs/blob/main/content/reference/api/hub/deprecated.md
We should probably start thinking of some more formalized deprecation document (what’s our policy, how announced, etc), although in most cases actually removing endpoints / features from the API may be more complicated, or at least, not without a major version bump of the API and ultimately fully dropping support for prior major versions; https://docs.docker.com/engine/deprecated/
There was a problem hiding this comment.
I have reformat and reorganize a bit "Docker Hub API" and "DVP Data API" to have the same structure : Changelog, Deprecated and OpenAPI.
The message in deprecated is pretty generic and strongly inspired by https://docs.docker.com/engine/deprecated/ with "date" instead of "release" and "endpoint" instead of "feature".
| title: Docker Hub API v1 (deprecated) | ||
| weight: 3 | ||
| aliases: | ||
| - /docker-hub/api/deprecated/ |
There was a problem hiding this comment.
We'll probably want to keep the alias, which is used for redirects
|
|
||
| As changes are made to Docker there may be times when existing endpoints need to be removed or replaced with newer endpoints. Before an existing endpoint is removed it is labeled as "deprecated" within the documentation. After some time it may be removed. | ||
|
|
||
| ## Deprecated engine endpoints |
There was a problem hiding this comment.
Probably a copy/paste from elsewhere;
| ## Deprecated engine endpoints | |
| ## Deprecated endpoints |
|
|
||
| ### Docker Hub API v1 deprecation | ||
|
|
||
| Docker Hub API v1 has been deprecated. Please use Docker Hub API v2 instead. |
There was a problem hiding this comment.
| Docker Hub API v1 has been deprecated. Please use Docker Hub API v2 instead. | |
| Docker Hub API v1 has been deprecated. Use Docker Hub API v2 instead. |
| --- | ||
| description: Docker Hub API changelog | ||
| title: Docker Hub API changelog | ||
| linkTitle: Changelog |
There was a problem hiding this comment.
Can you add an alias for the previous URL? Something like;
| linkTitle: Changelog | |
| linkTitle: Changelog | |
| aliases: | |
| - /reference/api/hub/latest-changelog/ |
| linkTitle: Docker Hub API | ||
| weight: 1 | ||
| description: Reference documentation and Swagger (OpenAPI) specification for the Docker Hub API. | ||
| title: OpenAPI |
There was a problem hiding this comment.
Looks like the title went missing here; can you add back the title, and a linkTitle (for the navigation)?
| linkTitle: DVP Data API | ||
| title: Docker Verified Publisher API reference | ||
| weight: 4 | ||
| title: OpenAPI |
There was a problem hiding this comment.
Looks like the title went missing here as well; can you add those back (title and a short linkTitle for the navigation)
As this page moved, we'd also want to add aliases here;
| title: OpenAPI | |
| title: Docker Verified Publisher API reference | |
| linkTitle: DVP Data API | |
| aliases: | |
| - /reference/api/hub/dvp/ |
Instead of making latest the canonical URL, we could consider keeping it as index (_index.md), adding /reference/api/hub/dvp/latest/ as alias. We do this for the Engine API, where https://docs.docker.com/reference/api/engine/latest/ (for convenience) links to the versioned URL for the latest API version; https://docs.docker.com/reference/api/engine/version/v1.50/
There was a problem hiding this comment.
Can't comment inline because there's no diff in the file; not sure if people reference this file directly (if that's the case, we may need to add a redirect through other means).
Description
GET /v2/namespaces/{namespace}/repositoriesAfter the comments from @thaJeztah
Related issues or tickets
Reviews