diff --git a/.htmltest.yml b/.htmltest.yml index 2af58c68c0..cfb602d513 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -7,7 +7,7 @@ IgnoreAltEmpty: true IgnoreEmptyHref: true IgnoreDirectoryMissingTrailingSlash: true IgnoreURLs: -- "^/docker-hub/api/latest/.*$" +- "^/reference/api/docker-hub/.*$" - "^/engine/api/v.+/#.*$" - "^/glossary/.*$" IgnoreDirs: diff --git a/content/docker-hub/_index.md b/content/docker-hub/_index.md index 210300b3e0..ce411f4062 100644 --- a/content/docker-hub/_index.md +++ b/content/docker-hub/_index.md @@ -40,7 +40,7 @@ GitHub and Bitbucket and push them to Docker Hub. * [Webhooks](webhooks.md): Trigger actions after a successful push to a repository to integrate Docker Hub with other services. * [Docker Hub CLI](https://github.com/docker/hub-tool#readme) tool (currently experimental) and an API that allows you to interact with Docker Hub. - * Browse through the [Docker Hub API](/docker-hub/api/latest/) documentation to explore the supported endpoints. + * Browse through the [Docker Hub API](/reference/api/docker-hub/latest/) documentation to explore the supported endpoints. {{< /tab >}} {{< tab name="What administrative tasks can I perform in Docker Hub?" >}} * [Create and manage teams and organizations](orgs.md) diff --git a/content/docker-hub/release-notes.md b/content/docker-hub/release-notes.md index 27b5fd6757..d45adb116f 100644 --- a/content/docker-hub/release-notes.md +++ b/content/docker-hub/release-notes.md @@ -139,7 +139,7 @@ The updated [Docker Subscription Service Agreement](https://www.docker.com/legal When managing the content of your repositories, you can now filter the results based on the currentness of the tags and more easily identify your untagged images. -For Docker Hub API documentation, see [Docker Hub API Reference](api/latest.md#operation/GetNamespacesRepositoriesImages). +For Docker Hub API documentation, see [Docker Hub API Reference](/reference/api/docker-hub/latest.md#operation/GetNamespacesRepositoriesImages). ## 2021-04-13 diff --git a/content/reference/_index.md b/content/reference/_index.md index dc8d1d007e..f18009fcc7 100644 --- a/content/reference/_index.md +++ b/content/reference/_index.md @@ -37,11 +37,11 @@ grid_apis: - title: Docker Hub API description: API to interact with Docker Hub. icon: communities - link: /docker-hub/api/latest/ + link: /reference/api/docker-hub/latest/ - title: DVP Data API description: API for Docker Verified Publishers to fetch analytics data. icon: area_chart - link: /docker-hub/api/dvp/ + link: /reference/api/docker-hub/dvp/ --- This section includes the reference documentation for the Docker platform's diff --git a/content/docker-hub/api/deprecated.md b/content/reference/api/docker-hub/deprecated.md similarity index 65% rename from content/docker-hub/api/deprecated.md rename to content/reference/api/docker-hub/deprecated.md index 26cde3fe79..218aaf82ee 100644 --- a/content/docker-hub/api/deprecated.md +++ b/content/reference/api/docker-hub/deprecated.md @@ -2,6 +2,8 @@ description: Docker Hub API v1 (deprecated) keywords: kitematic, deprecated title: Docker Hub API v1 (deprecated) +aliases: + - /docker-hub/api/deprecated/ --- > **Deprecated** @@ -18,11 +20,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](../../docker-hub/api/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](../../docker-hub/api/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](../../docker-hub/api/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](../../docker-hub/api/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}](../../docker-hub/api/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}](../../docker-hub/api/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get) | +| **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/docker-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/docker-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/docker-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/docker-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/docker-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/docker-hub/latest.md#tag/repositories/paths/~1v2~1namespaces~1%7Bnamespace%7D~1repositories~1%7Brepository%7D~1tags~1%7Btag%7D/get) | diff --git a/content/docker-hub/api/dvp.md b/content/reference/api/docker-hub/dvp.md similarity index 100% rename from content/docker-hub/api/dvp.md rename to content/reference/api/docker-hub/dvp.md diff --git a/content/docker-hub/api/dvp.yaml b/content/reference/api/docker-hub/dvp.yaml similarity index 99% rename from content/docker-hub/api/dvp.yaml rename to content/reference/api/docker-hub/dvp.yaml index e30353aded..671396822b 100644 --- a/content/docker-hub/api/dvp.yaml +++ b/content/reference/api/docker-hub/dvp.yaml @@ -690,5 +690,5 @@ components: description: | JWT Bearer Authentication is required to access the Docker DVP Data API. - This authentication documentation is duplicated from the [Hub API Authentication docs](https://docs.docker.com/docker-hub/api/latest/#tag/authentication) + This authentication documentation is duplicated from the [Hub API Authentication docs](https://docs.docker.com/reference/api/docker-hub/#tag/authentication) x-displayName: Docker Hub Authentication diff --git a/content/docker-hub/api/latest.md b/content/reference/api/docker-hub/latest.md similarity index 100% rename from content/docker-hub/api/latest.md rename to content/reference/api/docker-hub/latest.md diff --git a/content/docker-hub/api/latest.yaml b/content/reference/api/docker-hub/latest.yaml similarity index 100% rename from content/docker-hub/api/latest.yaml rename to content/reference/api/docker-hub/latest.yaml diff --git a/content/security/faqs/single-sign-on/users-faqs.md b/content/security/faqs/single-sign-on/users-faqs.md index e698b44859..177d98da6b 100644 --- a/content/security/faqs/single-sign-on/users-faqs.md +++ b/content/security/faqs/single-sign-on/users-faqs.md @@ -63,7 +63,7 @@ Docker SSO provides Just-in-Time (JIT) provisioning by default, with an option t [SCIM](../../../security/for-admins/provisioning/scim/) is available to provide full synchronization with users and groups. When you auto-provision users with SCIM, the recommended configuration is to disable JIT so that all auto-provisioning is handled by SCIM. -Additionally, you can use the [Docker Hub API](/docker-hub/api/latest/) to complete this process. +Additionally, you can use the [Docker Hub API](/reference/api/docker-hub/latest/) to complete this process. ### How does disabling Just-in-Time provisioning impact user sign-in? diff --git a/content/security/for-admins/provisioning/scim.md b/content/security/for-admins/provisioning/scim.md index 49e1ace729..93b4cdf213 100644 --- a/content/security/for-admins/provisioning/scim.md +++ b/content/security/for-admins/provisioning/scim.md @@ -31,7 +31,7 @@ The following table lists the supported attributes. Note that your attribute map | name.familyName | User’s surname | | active | Indicates if a user is enabled or disabled. Can be set to false to de-provision the user. | -For additional details about supported attributes and SCIM, see [Docker Hub API SCIM reference](/docker-hub/api/latest/#tag/scim). +For additional details about supported attributes and SCIM, see [Docker Hub API SCIM reference](/reference/api/docker-hub/latest/#tag/scim). > [!IMPORTANT] > diff --git a/content/trusted-content/insights-analytics.md b/content/trusted-content/insights-analytics.md index c54651e028..9dea519b19 100644 --- a/content/trusted-content/insights-analytics.md +++ b/content/trusted-content/insights-analytics.md @@ -60,7 +60,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](/docker-hub/api/dvp/). All members of an organization have access to the analytics data. +[DVP Data API](/reference/api/docker-hub/dvp.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 @@ -88,7 +88,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](/docker-hub/api/dvp/). +using the API in the [DVP Data API documentation](/reference/api/docker-hub/dvp.md). ## Data points diff --git a/data/redirects.yml b/data/redirects.yml index f6f2b3769d..074261fdbc 100644 --- a/data/redirects.yml +++ b/data/redirects.yml @@ -101,6 +101,10 @@ "/desktop/windows/wsl/": # Link used by Docker Desktop to refer users on how to activate WSL 2 - /go/wsl2/ +"/reference/api/docker-hub/latest/": + - /docker-hub/api/latest/ +"/reference/api/docker-hub/dvp/": + - /docker-hub/api/dvp/ # feedback "https://docs.google.com/forms/d/e/1FAIpQLSenjK8KiBiOrwCpq06u_iVEZGv4tfTEpfmY_cQDmsqJrHL9Gw/viewform": diff --git a/data/toc.yaml b/data/toc.yaml index b74db109e8..23d99de1d0 100644 --- a/data/toc.yaml +++ b/data/toc.yaml @@ -980,11 +980,11 @@ Reference: - sectiontitle: Docker Hub API section: - title: Docker Hub API - path: /docker-hub/api/latest/ + path: /reference/api/docker-hub/latest/ - title: DVP Data API - path: /docker-hub/api/dvp/ + path: /reference/api/docker-hub/dvp/ - title: Deprecated API - path: /docker-hub/api/deprecated/ + path: /reference/api/docker-hub/deprecated/ - sectiontitle: Docker Extension SDK API section: - path: /extensions/extensions-sdk/dev/api/reference/interfaces/DesktopUI/ diff --git a/layouts/_default/hub-api-baseof.html b/layouts/_default/hub-api-baseof.html index b2c71ed473..ef30b5d8c6 100644 --- a/layouts/_default/hub-api-baseof.html +++ b/layouts/_default/hub-api-baseof.html @@ -11,7 +11,7 @@ {{ partialCached "favicon.html" "favicon" }} - +