Skip to content

[docker-hub-api] add list namespace repositories endpoint #22934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 15, 2025
Merged

[docker-hub-api] add list namespace repositories endpoint #22934

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
42a7b45
[docker-hub-api] add list namespace repositories endpoint
vdamery Jun 27, 2025
bb7670c
[docker-hub-api] reformat and reorganize hub and dvp
vdamery Jun 27, 2025
31209ce
fixup! review
vdamery Jul 1, 2025
6628c25
fixup! review change `OpenApi` to `Latest` and the order of links
vdamery Jul 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/manuals/docker-hub/repos/manage/trusted-content/insights-analytics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ You can download extension CSV reports from the **Insights and analytics** dashb
## Exporting analytics data

You can export the analytics data either from the web dashboard, or using the
[DVP Data API](/reference/api/hub/dvp.md). All members of an organization have access to the analytics data.
[DVP Data API](/reference/api/dvp/latest.md). All members of an organization have access to the analytics data.

The data is available as a downloadable CSV file, in a weekly (Monday through
Sunday) or monthly format. Monthly data is available from the first day of the
Expand Down Expand Up @@ -89,7 +89,7 @@ Export usage data for your organization's images using the Docker Hub website by

The HTTP API endpoints are available at:
`https://hub.docker.com/api/publisher/analytics/v1`. Learn how to export data
using the API in the [DVP Data API documentation](/reference/api/hub/dvp.md).
using the API in the [DVP Data API documentation](/reference/api/dvp/latest.md).

## Data points

Expand Down
2 changes: 1 addition & 1 deletion content/reference/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ params:
- title: DVP Data API
description: API for Docker Verified Publishers to fetch analytics data.
icon: area_chart
link: /reference/api/hub/dvp/
link: /reference/api/dvp/latest/
- title: Registry API
description: API for Docker Registry.
icon: database
Expand Down
6 changes: 6 additions & 0 deletions content/reference/api/dvp/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: DVP Data API
build:
render: never
---

20 changes: 20 additions & 0 deletions content/reference/api/dvp/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
description: Docker Verified Publisher API changelog
title: Docker Verified Publisher API changelog
linkTitle: Changelog
keywords: docker dvp, dvp, whats new, release notes, api, changelog

Check failure on line 5 in content/reference/api/dvp/changelog.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'api'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'api'?", "location": {"path": "content/reference/api/dvp/changelog.md", "range": {"start": {"line": 5, "column": 54}}}, "severity": "ERROR"}

Check failure on line 5 in content/reference/api/dvp/changelog.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'dvp'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'dvp'?", "location": {"path": "content/reference/api/dvp/changelog.md", "range": {"start": {"line": 5, "column": 23}}}, "severity": "ERROR"}

Check failure on line 5 in content/reference/api/dvp/changelog.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'dvp'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'dvp'?", "location": {"path": "content/reference/api/dvp/changelog.md", "range": {"start": {"line": 5, "column": 18}}}, "severity": "ERROR"}
weight: 1
toc_min: 1
toc_max: 2
---

Here you can learn about the latest changes, new features, bug fixes, and known
issues for Docker Verified Publisher API.

---

## 2025-06-27

### New

- Create changelog
37 changes: 37 additions & 0 deletions content/reference/api/dvp/deprecated.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
description: Deprecated Docker Verified Publisher API endpoints
keywords: deprecated
title: Deprecated Docker Verified Publisher API endpoints
linkTitle: Deprecated
weight: 2
---

This page provides an overview of endpoints that are deprecated in Docker Verified Publisher API.

## Endpoint deprecation policy

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

The following table provides an overview of the current status of deprecated endpoints:

**Deprecated**: the endpoint is marked "deprecated" and should no longer be used.

The endpoint may be removed, disabled, or change behavior in a future release.

**Removed**: the endpoint was removed, disabled, or hidden.

---

| Status | Feature | Date |
|--------|---------------------------------------------------------------|------------|
| | [Create deprecation log table](#create-deprecation-log-table) | 2025-06-27 |

---

### Create deprecation log table

Reformat page

---
5 changes: 2 additions & 3 deletions content/reference/api/hub/dvp.md → content/reference/api/dvp/latest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: api
description: Reference documentation and Swagger (OpenAPI) specification for the Docker Verified Publisher API.
linkTitle: DVP Data API
title: Docker Verified Publisher API reference
weight: 4
title: OpenAPI
Copy link
Member

Choose a reason for hiding this comment

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

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;

Suggested change
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/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Now http://localhost:1313/reference/api/hub/dvp/ -> http://localhost:1313/reference/api/dvp/latest/` OK

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't know the app behind these dvp endpoints so I would not know what to put as version.
Can this be done later when the team responsible for DVP will update there openapi.yaml ?

And for docker hub api, the endpoints are a collection from multiple services so I don't know what should I put as a version too :/

weight: 3
---
0 content/reference/api/hub/dvp.yaml → content/reference/api/dvp/latest.yaml
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

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

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).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Now http://localhost:1313/reference/api/hub/dvp.yaml -> http://localhost:1313/reference/api/dvp/latest.yaml OK

File renamed without changes.
41 changes: 41 additions & 0 deletions content/reference/api/hub/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
description: Docker Hub API changelog
title: Docker Hub API changelog
linkTitle: Changelog
keywords: docker hub, hub, whats new, release notes, api, changelog

Check failure on line 5 in content/reference/api/hub/changelog.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'api'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'api'?", "location": {"path": "content/reference/api/hub/changelog.md", "range": {"start": {"line": 5, "column": 54}}}, "severity": "ERROR"}

Check failure on line 5 in content/reference/api/hub/changelog.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Docker Hub' instead of 'docker hub'.

Raw Output:
{"message": "[Vale.Terms] Use 'Docker Hub' instead of 'docker hub'.", "location": {"path": "content/reference/api/hub/changelog.md", "range": {"start": {"line": 5, "column": 11}}}, "severity": "ERROR"}
weight: 1
toc_min: 1
toc_max: 2
---

Here you can learn about the latest changes, new features, bug fixes, and known
issues for Docker Service APIs.

---

## 2025-06-27

### New

- Add [List repositories](/reference/api/hub/latest/#tag/repositories/operation/listNamespaceRepositories) endpoints for a given `namespace`.

### Deprecations

- [Deprecate /v2/repositories/{namespace}](/reference/api/hub/deprecated/#deprecate-legacy-listnamespacerepositories)

---

## 2025-03-25

### New

- Add [APIs](/reference/api/hub/latest/#tag/org-access-tokens) for organization access token (OATs) management.

---

## 2025-03-18

### New

- Add access to [audit logs](/reference/api/hub/latest/#tag/audit-logs) for org
access tokens.
71 changes: 54 additions & 17 deletions content/reference/api/hub/deprecated.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,52 @@
---
description: Docker Hub API v1 (deprecated)
keywords: kitematic, deprecated
title: Docker Hub API v1 (deprecated)
weight: 3
aliases:
- /docker-hub/api/deprecated/
description: Deprecated Docker Hub API endpoints
keywords: deprecated
title: Deprecated Docker Hub API endpoints
linkTitle: Deprecated
weight: 2
---

> **Deprecated**
>
> Docker Hub API v1 has been deprecated. Please use Docker Hub API v2 instead.
This page provides an overview of endpoints that are deprecated in Docker Hub API.

## Endpoint deprecation policy

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

The following table provides an overview of the current status of deprecated endpoints:

**Deprecated**: the endpoint is marked "deprecated" and should no longer be used.

The endpoint may be removed, disabled, or change behavior in a future release.

**Removed**: the endpoint was removed, disabled, or hidden.

---

| Status | Feature | Date |
|------------|---------------------------------------------------------------------------------------|------------|
| Deprecated | [Deprecate /v2/repositories/{namespace}](#deprecate-legacy-listnamespacerepositories) | 2025-06-27 |
| | [Create deprecation log table](#create-deprecation-log-table) | 2025-06-27 |
| Removed | [Docker Hub API v1 deprecation](#docker-hub-api-v1-deprecation) | 2022-08-23 |

---

### Deprecate legacy ListNamespaceRepositories

Deprecate undocumented endpoint `GET /v2/repositories/{namespace}` replaced by [List repositories](/reference/api/hub/latest/#tag/repositories/operation/listNamespaceRepositories).

---

### Create deprecation log table

Reformat page

---

### Docker Hub API v1 deprecation

Docker Hub API v1 has been deprecated. Please use Docker Hub API v2 instead.

Check warning on line 49 in content/reference/api/hub/deprecated.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Docker.Avoid] Consider removing 'Please'.

Raw Output:
{"message": "[Docker.Avoid] Consider removing 'Please'.", "location": {"path": "content/reference/api/hub/deprecated.md", "range": {"start": {"line": 49, "column": 40}}}, "severity": "WARNING"}

The following API routes within the v1 path will no longer work and will return a 410 status code:
* `/v1/repositories/{name}/images`
Expand All @@ -21,11 +58,11 @@

If you want to continue using the Docker Hub API in your current applications, update your clients to use v2 endpoints.

| **OLD** | **NEW** |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [/v1/repositories/{name}/images](https://github.com/moby/moby/blob/v1.3.0/docs/sources/reference/api/docker-io_api.md#list-user-repository-images) | [/v2/namespaces/{namespace}/repositories/{repository}/images](/reference/api/hub/latest.md#tag/images/operation/GetNamespacesRepositoriesImages) |
| [/v1/repositories/{namespace}/{name}/images](https://github.com/moby/moby/blob/v1.3.0/docs/sources/reference/api/docker-io_api.md#list-user-repository-images) | [/v2/namespaces/{namespace}/repositories/{repository}/images](/reference/api/hub/latest.md#tag/images/operation/GetNamespacesRepositoriesImages) |
| [/v1/repositories/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags) | [/v2/namespaces/{namespace}/repositories/{repository}/tags](/reference/api/hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get) |
| [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags) | [/v2/namespaces/{namespace}/repositories/{repository}/tags](/reference/api/hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags/get) |
| [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag) | [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](/reference/api/hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get) |
| [/v1/repositories/{namespace}/{name}/tags/{tag_name}](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag) | [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](/reference/api/hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get) |
| **OLD** | **NEW** |

Check warning on line 61 in content/reference/api/hub/deprecated.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Docker.Acronyms] 'NEW' has no definition.

Raw Output:
{"message": "[Docker.Acronyms] 'NEW' has no definition.", "location": {"path": "content/reference/api/hub/deprecated.md", "range": {"start": {"line": 61, "column": 172}}}, "severity": "WARNING"}

Check warning on line 61 in content/reference/api/hub/deprecated.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Docker.Acronyms] 'OLD' has no definition.

Raw Output:
{"message": "[Docker.Acronyms] 'OLD' has no definition.", "location": {"path": "content/reference/api/hub/deprecated.md", "range": {"start": {"line": 61, "column": 5}}}, "severity": "WARNING"}
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
| [/v1/repositories/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags) | [/v2/namespaces/{namespace}/repositories/{repository}/tags](/reference/api/hub/latest/#tag/repositories/operation/ListRepositoryTags) |
| [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#list-repository-tags) | [/v2/namespaces/{namespace}/repositories/{repository}/tags](/reference/api/hub/latest.md/#tag/repositories/operation/ListRepositoryTags) |
| [/v1/repositories/{namespace}/{name}/tags](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag) | [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](/reference/api/hub/latest/#tag/repositories/operation/GetRepositoryTag) |
| [/v1/repositories/{namespace}/{name}/tags/{tag_name}](https://github.com/moby/moby/blob/v1.8.3/docs/reference/api/registry_api.md#get-image-id-for-a-particular-tag) | [/v2/namespaces/{namespace}/repositories/{repository}/tags/{tag}](/reference/api/hub/latest/#tag/repositories/operation/GetRepositoryTag) |

---
25 changes: 0 additions & 25 deletions content/reference/api/hub/latest-changelog.md
View file
Open in desktop

This file was deleted.

7 changes: 3 additions & 4 deletions content/reference/api/hub/latest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
layout: api
description: Reference documentation and OpenAPI specification for the Docker Hub API.
title: Docker Hub API reference
linkTitle: Docker Hub API
weight: 1
description: Reference documentation and Swagger (OpenAPI) specification for the Docker Hub API.
title: OpenAPI
weight: 3
---
Loading