Skip to content

Commit bb7670c

Browse files
vdameryvdamery
committed
[docker-hub-api] reformat and reorganize hub and dvp
1 parent 42a7b45 commit bb7670c

File tree

11 files changed

+143
-34
lines changed

11 files changed

+143
-34
lines changed

‎content/manuals/docker-hub/repos/manage/trusted-content/insights-analytics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ You can download extension CSV reports from the **Insights and analytics** dashb
6161
## Exporting analytics data
6262

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

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

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

9494
## Data points
9595

‎content/reference/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ params:
4141
- title: DVP Data API
4242
description: API for Docker Verified Publishers to fetch analytics data.
4343
icon: area_chart
44-
link: /reference/api/hub/dvp/
44+
link: /reference/api/dvp/latest/
4545
- title: Registry API
4646
description: API for Docker Registry.
4747
icon: database

‎content/reference/api/dvp/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: DVP Data API
3+
build:
4+
render: never
5+
---
6+

‎content/reference/api/dvp/changelog.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
description: Docker Verified Publisher API changelog
3+
title: Docker Verified Publisher API changelog
4+
linkTitle: Changelog
5+
keywords: docker dvp, dvp, whats new, release notes, api, changelog
6+
weight: 1
7+
toc_min: 1
8+
toc_max: 2
9+
---
10+
11+
Here you can learn about the latest changes, new features, bug fixes, and known
12+
issues for Docker Verified Publisher API.
13+
14+
---
15+
16+
## 2025-06-27
17+
18+
### New
19+
20+
- Create changelog

‎content/reference/api/dvp/deprecated.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
description: Deprecated Docker Verified Publisher API endpoints
3+
keywords: deprecated
4+
title: Deprecated Docker Verified Publisher API endpoints
5+
linkTitle: Deprecated
6+
weight: 2
7+
---
8+
9+
This page provides an overview of endpoints that are deprecated in Docker Verified Publisher API.
10+
11+
## Endpoint deprecation policy
12+
13+
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.
14+
15+
## Deprecated engine endpoints
16+
17+
The following table provides an overview of the current status of deprecated endpoints:
18+
19+
**Deprecated**: the endpoint is marked "deprecated" and should no longer be used.
20+
21+
The endpoint may be removed, disabled, or change behavior in a future release.
22+
23+
**Removed**: the endpoint was removed, disabled, or hidden.
24+
25+
---
26+
27+
| Status | Feature | Date |
28+
|--------|---------------------------------------------------------------|------------|
29+
| | [Create deprecation log table](#create-deprecation-log-table) | 2025-06-27 |
30+
31+
---
32+
33+
### Create deprecation log table
34+
35+
Reformat page
36+
37+
---

‎content/reference/api/hub/dvp.md renamed to ‎content/reference/api/dvp/latest.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
layout: api
33
description: Reference documentation and Swagger (OpenAPI) specification for the Docker Verified Publisher API.
4-
linkTitle: DVP Data API
5-
title: Docker Verified Publisher API reference
6-
weight: 4
4+
title: OpenAPI
5+
weight: 3
76
---

‎content/reference/api/hub/dvp.yaml renamed to ‎content/reference/api/dvp/latest.yaml

File renamed without changes.

‎content/reference/api/hub/latest-changelog.md renamed to ‎content/reference/api/hub/changelog.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,38 @@
11
---
2-
description: Docker Hub API Changelog
3-
keywords: hub, api, changelog
4-
title: Docker Hub API Changelog
5-
keywords: docker hub, whats new, release notes, api, changelog
6-
weight: 2
2+
description: Docker Hub API changelog
3+
title: Docker Hub API changelog
4+
linkTitle: Changelog
5+
keywords: docker hub, hub, whats new, release notes, api, changelog
6+
weight: 1
77
toc_min: 1
88
toc_max: 2
99
---
1010

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

14+
---
15+
1416
## 2025-06-27
1517

1618
### New
1719

1820
- Add [List repositories](/reference/api/hub/latest/#tag/repositories/operation/listNamespaceRepositories) endpoints for a given `namespace`.
19-
- Deprecate undocumented endpoint `GET /v2/repositories/{namespace}` replaced by [List repositories](/reference/api/hub/latest/#tag/repositories/operation/listNamespaceRepositories).
21+
22+
### Deprecations
23+
24+
- [Deprecate /v2/repositories/{namespace}](/reference/api/hub/deprecated/#deprecate-legacy-listnamespacerepositories)
25+
26+
---
2027

2128
## 2025-03-25
2229

2330
### New
2431

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

34+
---
35+
2736
## 2025-03-18
2837

2938
### New

‎content/reference/api/hub/deprecated.md

Lines changed: 54 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,52 @@
11
---
2-
description: Docker Hub API v1 (deprecated)
3-
keywords: kitematic, deprecated
4-
title: Docker Hub API v1 (deprecated)
5-
weight: 3
6-
aliases:
7-
- /docker-hub/api/deprecated/
2+
description: Deprecated Docker Hub API endpoints
3+
keywords: deprecated
4+
title: Deprecated Docker Hub API endpoints
5+
linkTitle: Deprecated
6+
weight: 2
87
---
98

10-
> **Deprecated**
11-
>
12-
> Docker Hub API v1 has been deprecated. Please use Docker Hub API v2 instead.
9+
This page provides an overview of endpoints that are deprecated in Docker Hub API.
10+
11+
## Endpoint deprecation policy
12+
13+
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.
14+
15+
## Deprecated engine endpoints
16+
17+
The following table provides an overview of the current status of deprecated endpoints:
18+
19+
**Deprecated**: the endpoint is marked "deprecated" and should no longer be used.
20+
21+
The endpoint may be removed, disabled, or change behavior in a future release.
22+
23+
**Removed**: the endpoint was removed, disabled, or hidden.
24+
25+
---
26+
27+
| Status | Feature | Date |
28+
|------------|---------------------------------------------------------------------------------------|------------|
29+
| Deprecated | [Deprecate /v2/repositories/{namespace}](#deprecate-legacy-listnamespacerepositories) | 2025-06-27 |
30+
| | [Create deprecation log table](#create-deprecation-log-table) | 2025-06-27 |
31+
| Removed | [Docker Hub API v1 deprecation](#docker-hub-api-v1-deprecation) | 2022-08-23 |
32+
33+
---
34+
35+
### Deprecate legacy ListNamespaceRepositories
36+
37+
Deprecate undocumented endpoint `GET /v2/repositories/{namespace}` replaced by [List repositories](/reference/api/hub/latest/#tag/repositories/operation/listNamespaceRepositories).
38+
39+
---
40+
41+
### Create deprecation log table
42+
43+
Reformat page
44+
45+
---
46+
47+
### Docker Hub API v1 deprecation
48+
49+
Docker Hub API v1 has been deprecated. Please use Docker Hub API v2 instead.
1350

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

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

24-
| **OLD** | **NEW** |
25-
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
26-
| [/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) |
27-
| [/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) |
28-
| [/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) |
29-
| [/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) |
30-
| [/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) |
31-
| [/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) |
61+
| **OLD** | **NEW** |
62+
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
63+
| [/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) |
64+
| [/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) |
65+
| [/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) |
66+
| [/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) |
67+
68+
---

‎content/reference/api/hub/latest.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
layout: api
3-
description: Reference documentation and OpenAPI specification for the Docker Hub API.
4-
title: Docker Hub API reference
5-
linkTitle: Docker Hub API
6-
weight: 1
3+
description: Reference documentation and Swagger (OpenAPI) specification for the Docker Hub API.
4+
title: OpenAPI
5+
weight: 3
76
---

0 commit comments

Comments
 (0)