diff --git a/_config.yml b/_config.yml index 131e312efa..deda4cb9cb 100644 --- a/_config.yml +++ b/_config.yml @@ -21,7 +21,6 @@ exclude: ["_samples", "_scripts", "404.html", "datacenter", "ee", "index.html", # Component versions -- address like site.docker_ce_version # You can't have - characters in these for non-YAML reasons latest_engine_api_version: "1.41" -latest_hub_api_version: "2.0" docker_ce_version: "20.10" compose_version: "1.28.4" compose_file_v3: "3.9" diff --git a/_layouts/hub-api.html b/_layouts/hub-api.html index 64389ea53c..9c925cbc8e 100644 --- a/_layouts/hub-api.html +++ b/_layouts/hub-api.html @@ -13,7 +13,7 @@ - + diff --git a/_scripts/update-api-toc.sh b/_scripts/update-api-toc.sh index 4c9c172763..95608d4824 100755 --- a/_scripts/update-api-toc.sh +++ b/_scripts/update-api-toc.sh @@ -16,8 +16,3 @@ sedi () { # in toc.yaml. This is brittle! latest_engine_api_version="$(grep 'latest_engine_api_version:' ./_config.yml | grep -oh '"[0-9].*"$' | sed 's/"//g')" sedi "s/{{ site.latest_engine_api_version }}/${latest_engine_api_version}/g" ./_data/toc.yaml - -# Parse latest_hub_api_version variables from _config.yml to replace the value -# in toc.yaml. This is brittle! -latest_hub_api_version="$(grep 'latest_hub_api_version:' ./_config.yml | grep -oh '"[0-9].*"$' | sed 's/"//g')" -sedi "s/{{ site.latest_hub_api_version }}/${latest_hub_api_version}/g" ./_data/toc.yaml diff --git a/docker-hub/api/v2.0.md b/docker-hub/api/latest.md similarity index 100% rename from docker-hub/api/v2.0.md rename to docker-hub/api/latest.md diff --git a/docker-hub/api/v2.0.yaml b/docker-hub/api/latest.yaml similarity index 92% rename from docker-hub/api/v2.0.yaml rename to docker-hub/api/latest.yaml index eb834a7987..363f926d11 100644 --- a/docker-hub/api/v2.0.yaml +++ b/docker-hub/api/latest.yaml @@ -1,25 +1,37 @@ swagger: '2.0' schemes: - https +host: hub.docker.com +basePath: "/" produces: - application/json -basePath: /v2 +consumes: + - application/json info: title: Docker HUB API - version: '2.0' + version: 'beta' x-logo: url: https://docs.docker.com/images/logo-docker-main.png description: | - API for interacting with images stored on the Docker Hub registry + Docker Hub is a service provided by Docker for finding and sharing container images with your team. + It is the world's largest library and community for container images. + In addition to the [Docker Hub UI](https://docs.docker.com/docker-hub/) and [Docker Hub CLI tool](https://github.com/docker/hub-tool#readme) (currently experimental), + Docker provides an API that allows you to interact with Docker Hub. + Browse through the Docker Hub API documentation to explore the supported endpoints. tags: # Primary objects - name: Authentication x-displayName: Authentication - description: Authentication with the API + description: | + Most Docker Hub API endpoints require you to authenticate using you Docker credentials. + + Additionally, similar to the Docker Hub UI features, API endpoint responses may vary depending on your subscription (Free, Pro, or Team) and the permissions associated with it. + To learn more about the features available in each plan and to upgrade your existing plan, see [Docker Pricing](https://www.docker.com/pricing) - name: Images - x-displayName: Images - description: Get and manage images within a repository - + x-displayName: Advanced image management + description: | + The Advanced Image Management API endpoints aallow you to manage Docker images across all repositories. + For more information, see [Advanced Image Management dashboard](https://docs.docker.com/docker-hub/image-management/) definitions: UsersLoginRequest: description: User login details @@ -352,10 +364,6 @@ paths: The returned token is used in the HTTP Authentication header like `Authentication: JWT {TOKEN}` Most Docker Hub APIs require this token either to consume or to get detailed information (e.g. listing images of the private repository). - consumes: - - application/json - produces: - - application/json parameters: - name: body in: body @@ -493,19 +501,15 @@ paths: Deleting a currently tagged image will delete the tag from the repository. Errors cannot be ignored. Children of multi-arch images cannot be directly deleted. - consumes: - - application/json - produces: - - application/json parameters: - name: namespace in: path required: true description: Namespace of repository type: string - - name: body + - description: Delete request in: body - description: Delete request + name: body required: true schema: $ref: '#/definitions/PostNamespacesDeleteImagesRequest' diff --git a/docker-hub/api/latest/index.html b/docker-hub/api/latest/index.html index caef77b5ca..1f4d2347c0 100644 --- a/docker-hub/api/latest/index.html +++ b/docker-hub/api/latest/index.html @@ -1,6 +1,6 @@ --- --- - +

Redirecting to the latest version of the Docker Hub API reference. \ No newline at end of file