Skip to content

Commit

Permalink
Merge pull request #18760 from dvdksn/rm-advanced-image-mgmt
Browse files Browse the repository at this point in the history
hub: remove advanced image management
  • Loading branch information
dvdksn authored Dec 11, 2023
2 parents 0f7e6ec + f64a0f4 commit e7a5309
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 308 deletions.
259 changes: 0 additions & 259 deletions content/docker-hub/api/latest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -77,16 +77,6 @@ tags:
***Treat your personal access token like your password and keep it secret. You cannot retrieve
your token after it is generated.***
- name: images
x-displayName: Advanced Image Management
description: |
The Advanced Image Management API endpoints allow you to manage Docker
images across all repositories.
**<span style="color: red;">Deprecated</span>**: Advanced Image
Management is deprecated, and scheduled for removal on December 11th, 2023.
For more information, see [Deprecation of Advanced Image Management](https://github.com/docker/roadmap/issues/534).
- name: audit-logs
x-displayName: Audit Logs
description: |
Expand Down Expand Up @@ -308,255 +298,6 @@ paths:
$ref: "#/components/responses/Unauthorized"
404:
$ref: "#/components/responses/NotFound"
/v2/namespaces/{namespace}/repositories/{repository}/images-summary:
get:
deprecated: true
tags:
- images
summary: Get summary of repository's images
description: |
Gets the number of images in a repository and the number of images
counted as active and inactive.
operationId: GetNamespacesRepositoriesImagesSummary
parameters:
- name: namespace
in: path
required: true
description: Namespace of the repository.
schema:
type: string
- name: repository
in: path
required: true
description: Name of the repository.
schema:
type: string
- name: active_from
in: query
required: false
description: |
Sets the time from which an image must have been pushed or pulled to
be counted as active.
Defaults to 1 month before the current time.
schema:
type: string
responses:
200:
description: Success
content:
application/json:
schema:
$ref:
"#/components/schemas/GetNamespaceRepositoryImagesSummaryResponse"
401:
description: Unauthorized - user does not have read access to the namespace
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/v2/namespaces/{namespace}/repositories/{repository}/images:
get:
deprecated: true
tags:
- images
summary: Get details of repository's images
description: Gets details on the images in a repository.
operationId: GetNamespacesRepositoriesImages
parameters:
- name: namespace
in: path
required: true
description: Namespace of the repository.
schema:
type: string
- name: repository
in: path
required: true
description: Name of the repository.
schema:
type: string
- name: status
in: query
required: false
description: Filters to only show images of this status.
schema:
type: string
enum:
- active
- inactive
- name: currently_tagged
in: query
required: false
description: |
Filters to only show images with:
- `true`: at least 1 current tag.
- `false`: no current tags.
schema:
type: boolean
- name: ordering
in: query
required: false
description: |
Orders the results by this property.
Prefixing with `-` sorts by descending order.
schema:
type: string
enum:
- last_activity
- -last_activity
- digest
- -digest
- name: active_from
in: query
required: false
description: |
Sets the time from which an image must have been pushed or pulled to
be counted as active.
Defaults to 1 month before the current time.
schema:
type: string
- name: page
in: query
required: false
description: Page number to get. Defaults to 1.
schema:
type: integer
- name: page_size
in: query
required: false
description: Number of images to get per page. Defaults to 10. Max of 100.
schema:
type: integer
responses:
200:
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/GetNamespaceRepositoryImagesResponse"
401:
description: Unauthorized - user does not have read access to the namespace.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
403:
description: Forbidden - this API is only available to users on Pro or Team plans.
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/v2/namespaces/{namespace}/repositories/{repository}/images/{digest}/tags:
get:
deprecated: true
tags:
- images
summary: Get image's tags
description: Gets current and historical tags for an image.
operationId: GetNamespacesRepositoriesImagesTags
parameters:
- name: namespace
in: path
required: true
description: Namespace of the repository.
schema:
type: string
- name: repository
in: path
required: true
description: Name of the repository.
schema:
type: string
- name: digest
in: path
required: true
description: Digest of the image.
schema:
type: string
- name: page
in: query
required: false
description: Page number to get. Defaults to 1.
schema:
type: integer
- name: page_size
in: query
required: false
description: Number of images to get per page. Defaults to 10. Max of 100.
schema:
type: integer
responses:
200:
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/GetNamespaceRepositoryImagesTagsResponse"
401:
description: Unauthorized - user does not have read access to the namespace
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
403:
description: Forbidden - this API is only available to users on Pro or Team plans
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/v2/namespaces/{namespace}/delete-images:
post:
deprecated: true
tags:
- images
summary: Delete images
operationId: PostNamespacesDeleteImages
description: |
Deletes one or more images within a namespace. This is currently limited to a single
repository.
If you attempt to delete images that are marked as active or are currently tagged, the deletion does not happen and it displays the warnings.
To continue with the deletion, you must ignore these warnings by putting them in the `ignore_warnings` property.
Deleting a currently tagged image deletes the tag from the repository.
You cannot ignore errors. It is not possible to directly delete children of multi-arch images.
parameters:
- name: namespace
in: path
required: true
description: Namespace of the repository.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PostNamespacesDeleteImagesRequest"
description: Delete request.
required: true
responses:
200:
description: Deletion completed
content:
application/json:
schema:
$ref: "#/components/schemas/PostNamespacesDeleteImagesResponseSuccess"
400:
description: Deletion not possible
content:
application/json:
schema:
$ref: "#/components/schemas/PostNamespacesDeleteImagesResponseError"
403:
description: Forbidden - this API is only available to users on Pro or Team plans
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/v2/auditlogs/{account}:
get:
summary: Returns list of audit log events
Expand Down
45 changes: 0 additions & 45 deletions content/docker-hub/image-management.md

This file was deleted.

8 changes: 6 additions & 2 deletions content/docker-hub/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ known issues for each Docker Hub release.

Take a look at the [Docker Public Roadmap](https://github.com/docker/roadmap/projects/1) to see what's coming next.

## 2023-12-11

- The Advanced Image Management feature, along with the corresponding API endpoints, has been retired.
See [docker/roadmap#534](https://github.com/docker/roadmap/issues/534).

## 2023-08-28

- Organizations with SSO enabled can assign members to roles, organizations, and teams with [SCIM role mapping](scim.md#set-up-role-mapping).
Expand Down Expand Up @@ -117,7 +122,6 @@ The updated [Docker Subscription Service Agreement](https://www.docker.com/legal
### Enhancement

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 more information, see [Advanced Management Dashboard](image-management.md).

For Docker Hub API documentation, see [Docker Hub API Reference](api/latest.md#operation/GetNamespacesRepositoriesImages).

Expand All @@ -143,7 +147,7 @@ For details on how to update your billing information, see [Update billing infor

**Advanced Image Management dashboard**

Docker introduces the Advanced Image Management dashboard that enables you to view and manage Docker images in your repositories. For more information, see [Advanced Image Management dashboard](image-management.md).
Docker introduces the Advanced Image Management dashboard that enables you to view and manage Docker images in your repositories.

## 2021-01-25

Expand Down
2 changes: 0 additions & 2 deletions data/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2032,8 +2032,6 @@ Manuals:
title: Link to GitHub and BitBucket
- path: /docker-hub/vulnerability-scanning/
title: Vulnerability scanning
- path: /docker-hub/image-management/
title: Advanced Image Management
- path: /registry/
title: Registry
- path: /docker-hub/oci-artifacts/
Expand Down

0 comments on commit e7a5309

Please sign in to comment.