From 42a7b452f282bdfdea2060e36cffe08e5cc4dbab Mon Sep 17 00:00:00 2001 From: "vincent.damery" Date: Fri, 27 Jun 2025 11:58:25 +0200 Subject: [PATCH 1/3] [docker-hub-api] add list namespace repositories endpoint --- content/reference/api/hub/latest-changelog.md | 7 + content/reference/api/hub/latest.yaml | 269 +++++++++++++++++- 2 files changed, 275 insertions(+), 1 deletion(-) diff --git a/content/reference/api/hub/latest-changelog.md b/content/reference/api/hub/latest-changelog.md index c1c8d7ed42c..8d951aa2cc9 100644 --- a/content/reference/api/hub/latest-changelog.md +++ b/content/reference/api/hub/latest-changelog.md @@ -11,6 +11,13 @@ 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`. +- Deprecate undocumented endpoint `GET /v2/repositories/{namespace}` replaced by [List repositories](/reference/api/hub/latest/#tag/repositories/operation/listNamespaceRepositories). + ## 2025-03-25 ### New diff --git a/content/reference/api/hub/latest.yaml b/content/reference/api/hub/latest.yaml index 681870cc93d..747bb8f0bde 100644 --- a/content/reference/api/hub/latest.yaml +++ b/content/reference/api/hub/latest.yaml @@ -926,8 +926,152 @@ paths: $ref: "#/components/responses/forbidden" "404": $ref: "#/components/responses/NotFound" + /v2/namespaces/{namespace}/repositories: + parameters: + - $ref: "#/components/parameters/namespace" + get: + operationId: listNamespaceRepositories + summary: List repositories in a namespace + description: | + Returns a list of repositories within the specified namespace (organization or user). + + Public repositories are accessible to everyone, while private repositories require appropriate authentication and permissions. + tags: + - repositories + security: + - bearerAuth: [ ] + - { } # Allow anonymous access for public repositories + parameters: + - in: query + name: page + required: false + schema: + type: integer + minimum: 1 + default: 1 + description: Page number to get. Defaults to 1. + - in: query + name: page_size + required: false + schema: + type: integer + minimum: 1 + maximum: 1000 + default: 10 + description: Number of repositories to get per page. Defaults to 10. Max of 1000. + - in: query + name: name + required: false + schema: + type: string + description: Filter repositories by name (partial match). + - in: query + name: ordering + required: false + schema: + type: string + enum: + - name + - -name + - last_updated + - -last_updated + - pull_count + - -pull_count + description: | + Order repositories by the specified field. Prefix with '-' for descending order. + Available options: + - `name` / `-name`: Repository name (ascending/descending) + - `last_updated` / `-last_updated`: Last update time (ascending/descending) + - `pull_count` / `-pull_count`: Number of pulls (ascending/descending) + responses: + "200": + description: List of repositories + content: + application/json: + schema: + $ref: "#/components/schemas/list_repositories_response" + examples: + repositories_list: + value: + count: 287 + next: "https://hub.docker.com/v2/namespaces/docker/repositories?page=2&page_size=2" + previous: null + results: + - name: "highland_builder" + namespace: "docker" + repository_type: "image" + status: 1 + status_description: "active" + description: "Image for performing Docker build requests" + is_private: false + star_count: 7 + pull_count: 15722123 + last_updated: "2023-06-20T10:44:45.459826Z" + last_modified: "2024-10-16T13:48:34.145251Z" + date_registered: "2015-05-19T21:13:35.937763Z" + affiliation: "" + media_types: + - "application/octet-stream" + - "application/vnd.docker.container.image.v1+json" + - "application/vnd.docker.distribution.manifest.v1+prettyjws" + content_types: + - "unrecognized" + - "image" + categories: + - name: "Languages & frameworks" + slug: "languages-and-frameworks" + - name: "Integration & delivery" + slug: "integration-and-delivery" + - name: "Operating systems" + slug: "operating-systems" + storage_size: 488723114800 + - name: "whalesay" + namespace: "docker" + repository_type: null + status: 1 + status_description: "active" + description: "An image for use in the Docker demo tutorial" + is_private: false + star_count: 757 + pull_count: 130737682 + last_updated: "2015-06-19T19:06:27.388123Z" + last_modified: "2024-10-16T13:48:34.145251Z" + date_registered: "2015-06-09T18:16:36.527329Z" + affiliation: "" + media_types: + - "application/vnd.docker.distribution.manifest.v1+prettyjws" + content_types: + - "image" + categories: + - name: "Languages & frameworks" + slug: "languages-and-frameworks" + - name: "Integration & delivery" + slug: "integration-and-delivery" + storage_size: 103666708 + "400": + description: Bad Request - Invalid request parameters + content: + application/json: + schema: + $ref: "#/components/schemas/error" + examples: + invalid_ordering: + summary: Invalid ordering value + value: + fields: + ordering: [ "Invalid ordering value. Must be one of: name, -name, last_updated, -last_updated, pull_count, -pull_count" ] + text: "Invalid ordering value" + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + description: Page not found - occurs when requesting a page number `>1` that exceeds the available results + content: + application/json: + schema: + $ref: "#/components/schemas/error" - /v2/orgs/{org_name}/members: parameters: - $ref: "#/components/parameters/org_name" @@ -2009,6 +2153,129 @@ components: schema: $ref: "#/components/schemas/scim_user" schemas: + repository_list_entry: + type: object + properties: + name: + type: string + description: Name of the repository + example: "hello-world" + namespace: + type: string + description: Namespace (organization or username) that owns the repository + example: "docker" + repository_type: + type: string + description: Type of repository + enum: + - image + - plugin + - null + example: "image" + nullable: true + status: + type: integer + description: Repository status code + example: 1 + status_description: + type: string + description: Human-readable repository status + enum: + - active + - inactive + example: "active" + description: + type: string + description: Repository description + nullable: true + example: "Hello World! (an example of minimal Dockerization)" + is_private: + type: boolean + description: Whether the repository is private + example: false + star_count: + type: integer + description: Number of users who starred this repository + minimum: 0 + example: 1234 + pull_count: + type: integer + description: Total number of pulls for this repository + minimum: 0 + example: 50000000 + last_updated: + type: string + format: date-time + description: ISO 8601 timestamp of when the repository was last updated + example: "2023-12-01T10:30:00Z" + nullable: true + last_modified: + type: string + format: date-time + description: ISO 8601 timestamp of when the repository was last modified + example: "2023-12-01T10:30:00Z" + nullable: true + date_registered: + type: string + format: date-time + description: ISO 8601 timestamp of when the repository was created + example: "2013-06-19T19:07:54Z" + affiliation: + type: string + description: User's affiliation with the repository (empty string if no affiliation) + example: "" + media_types: + type: array + description: Media types supported by this repository + items: + type: string + example: + - "application/vnd.docker.plugin.v1+json" + content_types: + type: array + description: Content types supported by this repository + items: + type: string + example: + - "plugin" + categories: + type: array + description: Categories associated with this repository + items: + $ref: "#/components/schemas/category" + example: [] + storage_size: + type: integer + description: Storage size in bytes used by this repository + minimum: 0 + example: 232719127 + category: + type: object + required: + - name + - slug + properties: + name: + type: string + description: Human-readable name of the category + example: "Databases" + minLength: 1 + slug: + type: string + description: URL-friendly identifier for the category + example: "databases" + minLength: 1 + pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$" + description: Repository category for classification and discovery + list_repositories_response: + allOf: + - $ref: "#/components/schemas/page" + - type: object + properties: + results: + type: array + items: + $ref: "#/components/schemas/repository_list_entry" UsersLoginRequest: description: User login details type: object From bb7670c9a0ee579da800469c48de50d6fac70d5b Mon Sep 17 00:00:00 2001 From: "vincent.damery" Date: Fri, 27 Jun 2025 16:02:28 +0200 Subject: [PATCH 2/3] [docker-hub-api] reformat and reorganize hub and dvp --- .../trusted-content/insights-analytics.md | 4 +- content/reference/_index.md | 2 +- content/reference/api/dvp/_index.md | 6 ++ content/reference/api/dvp/changelog.md | 20 ++++++ content/reference/api/dvp/deprecated.md | 37 ++++++++++ .../api/{hub/dvp.md => dvp/latest.md} | 5 +- .../api/{hub/dvp.yaml => dvp/latest.yaml} | 0 .../hub/{latest-changelog.md => changelog.md} | 21 ++++-- content/reference/api/hub/deprecated.md | 71 ++++++++++++++----- content/reference/api/hub/latest.md | 7 +- content/reference/api/hub/latest.yaml | 4 +- 11 files changed, 143 insertions(+), 34 deletions(-) create mode 100644 content/reference/api/dvp/_index.md create mode 100644 content/reference/api/dvp/changelog.md create mode 100644 content/reference/api/dvp/deprecated.md rename content/reference/api/{hub/dvp.md => dvp/latest.md} (61%) rename content/reference/api/{hub/dvp.yaml => dvp/latest.yaml} (100%) rename content/reference/api/hub/{latest-changelog.md => changelog.md} (61%) diff --git a/content/manuals/docker-hub/repos/manage/trusted-content/insights-analytics.md b/content/manuals/docker-hub/repos/manage/trusted-content/insights-analytics.md index 4adf8b19bbf..078fda8f028 100644 --- a/content/manuals/docker-hub/repos/manage/trusted-content/insights-analytics.md +++ b/content/manuals/docker-hub/repos/manage/trusted-content/insights-analytics.md @@ -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 @@ -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 diff --git a/content/reference/_index.md b/content/reference/_index.md index d51c780f93f..f39ef589bc5 100644 --- a/content/reference/_index.md +++ b/content/reference/_index.md @@ -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 diff --git a/content/reference/api/dvp/_index.md b/content/reference/api/dvp/_index.md new file mode 100644 index 00000000000..18f6030ead2 --- /dev/null +++ b/content/reference/api/dvp/_index.md @@ -0,0 +1,6 @@ +--- +title: DVP Data API +build: + render: never +--- + diff --git a/content/reference/api/dvp/changelog.md b/content/reference/api/dvp/changelog.md new file mode 100644 index 00000000000..76c97932388 --- /dev/null +++ b/content/reference/api/dvp/changelog.md @@ -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 +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 diff --git a/content/reference/api/dvp/deprecated.md b/content/reference/api/dvp/deprecated.md new file mode 100644 index 00000000000..43994f4ed8c --- /dev/null +++ b/content/reference/api/dvp/deprecated.md @@ -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 + +--- \ No newline at end of file diff --git a/content/reference/api/hub/dvp.md b/content/reference/api/dvp/latest.md similarity index 61% rename from content/reference/api/hub/dvp.md rename to content/reference/api/dvp/latest.md index c4cc61554ca..4dbdc118a41 100644 --- a/content/reference/api/hub/dvp.md +++ b/content/reference/api/dvp/latest.md @@ -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 +weight: 3 --- diff --git a/content/reference/api/hub/dvp.yaml b/content/reference/api/dvp/latest.yaml similarity index 100% rename from content/reference/api/hub/dvp.yaml rename to content/reference/api/dvp/latest.yaml diff --git a/content/reference/api/hub/latest-changelog.md b/content/reference/api/hub/changelog.md similarity index 61% rename from content/reference/api/hub/latest-changelog.md rename to content/reference/api/hub/changelog.md index 8d951aa2cc9..5b833a0322a 100644 --- a/content/reference/api/hub/latest-changelog.md +++ b/content/reference/api/hub/changelog.md @@ -1,9 +1,9 @@ --- -description: Docker Hub API Changelog -keywords: hub, api, changelog -title: Docker Hub API Changelog -keywords: docker hub, whats new, release notes, api, changelog -weight: 2 +description: Docker Hub API changelog +title: Docker Hub API changelog +linkTitle: Changelog +keywords: docker hub, hub, whats new, release notes, api, changelog +weight: 1 toc_min: 1 toc_max: 2 --- @@ -11,12 +11,19 @@ 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`. -- Deprecate undocumented endpoint `GET /v2/repositories/{namespace}` replaced by [List repositories](/reference/api/hub/latest/#tag/repositories/operation/listNamespaceRepositories). + +### Deprecations + +- [Deprecate /v2/repositories/{namespace}](/reference/api/hub/deprecated/#deprecate-legacy-listnamespacerepositories) + +--- ## 2025-03-25 @@ -24,6 +31,8 @@ issues for Docker Service APIs. - Add [APIs](/reference/api/hub/latest/#tag/org-access-tokens) for organization access token (OATs) management. +--- + ## 2025-03-18 ### New diff --git a/content/reference/api/hub/deprecated.md b/content/reference/api/hub/deprecated.md index cd32c0d2c04..5b6dcff2cac 100644 --- a/content/reference/api/hub/deprecated.md +++ b/content/reference/api/hub/deprecated.md @@ -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. The following API routes within the v1 path will no longer work and will return a 410 status code: * `/v1/repositories/{name}/images` @@ -21,11 +58,11 @@ The following API routes within the v1 path will no longer work and will return 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** | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| [/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) | + +--- \ No newline at end of file diff --git a/content/reference/api/hub/latest.md b/content/reference/api/hub/latest.md index f70a8cc07eb..0c0408f6a19 100644 --- a/content/reference/api/hub/latest.md +++ b/content/reference/api/hub/latest.md @@ -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 --- diff --git a/content/reference/api/hub/latest.yaml b/content/reference/api/hub/latest.yaml index 747bb8f0bde..abff223767c 100644 --- a/content/reference/api/hub/latest.yaml +++ b/content/reference/api/hub/latest.yaml @@ -23,7 +23,7 @@ tags: - name: changelog x-displayName: Changelog description: | - See the [Changelog](/reference/api/hub/latest-changelog) for a summary of changes across Docker Hub API versions. + See the [Changelog](/reference/api/hub/changelog) for a summary of changes across Docker Hub API versions. - name: resources x-displayName: Resources description: | @@ -823,6 +823,7 @@ paths: - $ref: "#/components/parameters/namespace" - $ref: "#/components/parameters/repository" get: + operationId: ListRepositoryTags summary: List repository tags tags: - repositories @@ -867,6 +868,7 @@ paths: - $ref: "#/components/parameters/repository" - $ref: "#/components/parameters/tag" get: + operationId: GetRepositoryTag summary: Read repository tag tags: - repositories From 31209ce1a10bb3a958eb448a7b2ad85b30d1ac3e Mon Sep 17 00:00:00 2001 From: "vincent.damery" Date: Tue, 1 Jul 2025 15:47:26 +0200 Subject: [PATCH 3/3] fixup! review --- content/reference/api/dvp/deprecated.md | 2 +- content/reference/api/dvp/latest.md | 5 ++++- content/reference/api/hub/changelog.md | 2 ++ content/reference/api/hub/deprecated.md | 6 ++++-- content/reference/api/hub/dvp.yaml | 5 +++++ content/reference/api/hub/latest.md | 3 ++- 6 files changed, 18 insertions(+), 5 deletions(-) create mode 100644 content/reference/api/hub/dvp.yaml diff --git a/content/reference/api/dvp/deprecated.md b/content/reference/api/dvp/deprecated.md index 43994f4ed8c..d47f041c92f 100644 --- a/content/reference/api/dvp/deprecated.md +++ b/content/reference/api/dvp/deprecated.md @@ -12,7 +12,7 @@ This page provides an overview of endpoints that are deprecated in Docker Verifi 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 +## Deprecated endpoints The following table provides an overview of the current status of deprecated endpoints: diff --git a/content/reference/api/dvp/latest.md b/content/reference/api/dvp/latest.md index 4dbdc118a41..cd96ddf06d4 100644 --- a/content/reference/api/dvp/latest.md +++ b/content/reference/api/dvp/latest.md @@ -1,6 +1,9 @@ --- layout: api description: Reference documentation and Swagger (OpenAPI) specification for the Docker Verified Publisher API. -title: OpenAPI +title: Docker Verified Publisher API reference +linkTitle: OpenAPI weight: 3 +aliases: + - /reference/api/hub/dvp/ --- diff --git a/content/reference/api/hub/changelog.md b/content/reference/api/hub/changelog.md index 5b833a0322a..0c2958a8d68 100644 --- a/content/reference/api/hub/changelog.md +++ b/content/reference/api/hub/changelog.md @@ -6,6 +6,8 @@ keywords: docker hub, hub, whats new, release notes, api, changelog weight: 1 toc_min: 1 toc_max: 2 +aliases: + - /reference/api/hub/latest-changelog/ --- Here you can learn about the latest changes, new features, bug fixes, and known diff --git a/content/reference/api/hub/deprecated.md b/content/reference/api/hub/deprecated.md index 5b6dcff2cac..5e2ce9aabca 100644 --- a/content/reference/api/hub/deprecated.md +++ b/content/reference/api/hub/deprecated.md @@ -4,6 +4,8 @@ keywords: deprecated title: Deprecated Docker Hub API endpoints linkTitle: Deprecated weight: 2 +aliases: + - /docker-hub/api/deprecated/ --- This page provides an overview of endpoints that are deprecated in Docker Hub API. @@ -12,7 +14,7 @@ This page provides an overview of endpoints that are deprecated in Docker Hub AP 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 +## Deprecated endpoints The following table provides an overview of the current status of deprecated endpoints: @@ -46,7 +48,7 @@ Reformat page ### Docker Hub API v1 deprecation -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. The following API routes within the v1 path will no longer work and will return a 410 status code: * `/v1/repositories/{name}/images` diff --git a/content/reference/api/hub/dvp.yaml b/content/reference/api/hub/dvp.yaml new file mode 100644 index 00000000000..3a561a7be5c --- /dev/null +++ b/content/reference/api/hub/dvp.yaml @@ -0,0 +1,5 @@ +--- +outputs: + - redirect +url: /reference/api/dvp/latest.yaml +--- diff --git a/content/reference/api/hub/latest.md b/content/reference/api/hub/latest.md index 0c0408f6a19..843bcfd0528 100644 --- a/content/reference/api/hub/latest.md +++ b/content/reference/api/hub/latest.md @@ -1,6 +1,7 @@ --- layout: api description: Reference documentation and Swagger (OpenAPI) specification for the Docker Hub API. -title: OpenAPI +title: Docker Hub API reference +linkTitle: OpenAPI weight: 3 ---