diff --git a/specification/DigitalOcean-public.v2.yaml b/specification/DigitalOcean-public.v2.yaml index f99077674..2fc580b78 100644 --- a/specification/DigitalOcean-public.v2.yaml +++ b/specification/DigitalOcean-public.v2.yaml @@ -164,7 +164,7 @@ tags: if your container registry uses the Professional subscription plan. The storage is shared among the registries. This set of new APIs is backward compatible with `/v2/registry`. However, if you create more than one registry under a Professional plan, some of the `/v2/registry` APIs would not work. - Hence, it is recommended to use `/v2/registries` for multiple registries. Currently, these APIs are in Public Preview. + Hence, it is recommended to use `/v2/registries` for multiple registries. - name: Databases description: |- diff --git a/specification/resources/registry/examples/curl/registries_create.yml b/specification/resources/registry/examples/curl/registries_create.yml index cc0907de3..a2ac80efb 100644 --- a/specification/resources/registry/examples/curl/registries_create.yml +++ b/specification/resources/registry/examples/curl/registries_create.yml @@ -3,5 +3,5 @@ source: |- curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ - -d '{"name": "example", "region": "fra1"}' \ + -d '{"name": "example", "subscription_tier_slug": "basic", "region": "fra1"}' \ "https://api.digitalocean.com/v2/registries" diff --git a/specification/resources/registry/examples/python/registries_create.yml b/specification/resources/registry/examples/python/registries_create.yml index 72fdd445f..f31f1c79c 100644 --- a/specification/resources/registry/examples/python/registries_create.yml +++ b/specification/resources/registry/examples/python/registries_create.yml @@ -7,7 +7,8 @@ source: |- req = { "name": "example", - "region": "fra1" + "region": "fra1", + "subscription_tier_slug": "basic" } resp = client.registries.create(body=req) diff --git a/specification/resources/registry/registries_create.yml b/specification/resources/registry/registries_create.yml index c96f0c33e..7e6810e8c 100644 --- a/specification/resources/registry/registries_create.yml +++ b/specification/resources/registry/registries_create.yml @@ -1,6 +1,6 @@ operationId: registries_create -summary: "[Public Preview] Create Container Registry" +summary: "Create Container Registry" description: | To create your container registry, send a POST request to `/v2/registries`. diff --git a/specification/resources/registry/registries_delete.yml b/specification/resources/registry/registries_delete.yml index 5a773f556..7a788f6ca 100644 --- a/specification/resources/registry/registries_delete.yml +++ b/specification/resources/registry/registries_delete.yml @@ -1,6 +1,6 @@ operationId: registries_delete -summary: "[Public Preview] Delete Container Registry By Name" +summary: "Delete Container Registry By Name" description: To delete your container registry, destroying all container image data stored in it, send a DELETE request to `/v2/registries/{registry_name}`. diff --git a/specification/resources/registry/registries_delete_repository.yml b/specification/resources/registry/registries_delete_repository.yml index 2268d4ea5..d9f1057f7 100644 --- a/specification/resources/registry/registries_delete_repository.yml +++ b/specification/resources/registry/registries_delete_repository.yml @@ -1,6 +1,6 @@ operationId: registries_delete_repository -summary: "[Public Preview] Delete Container Registry Repository" +summary: "Delete Container Registry Repository" description: | To delete a container repository including all of its tags, send a DELETE request to diff --git a/specification/resources/registry/registries_delete_repositoryManifest.yml b/specification/resources/registry/registries_delete_repositoryManifest.yml index 73e7eeac5..521523ffb 100644 --- a/specification/resources/registry/registries_delete_repositoryManifest.yml +++ b/specification/resources/registry/registries_delete_repositoryManifest.yml @@ -1,6 +1,6 @@ operationId: registries_delete_repositoryManifest -summary: "[Public Preview] Delete Container Registry Repository Manifest" +summary: "Delete Container Registry Repository Manifest" description: | To delete a container repository manifest by digest in one of your registries, send a DELETE request to @@ -14,7 +14,7 @@ description: | A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully. - It is similar to DELETE `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests/$MANIFEST_DIGEST` and exists for backward compatibility. + It is similar to DELETE `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests/$MANIFEST_DIGEST`. tags: - Container Registries diff --git a/specification/resources/registry/registries_delete_repositoryTag.yml b/specification/resources/registry/registries_delete_repositoryTag.yml index b9b6db48a..0a05c263e 100644 --- a/specification/resources/registry/registries_delete_repositoryTag.yml +++ b/specification/resources/registry/registries_delete_repositoryTag.yml @@ -1,6 +1,6 @@ operationId: registries_delete_repositoryTag -summary: "[Public Preview] Delete Container Registry Repository Tag" +summary: "Delete Container Registry Repository Tag" description: | To delete a container repository tag in on of our container registries, send a DELETE request to @@ -12,7 +12,7 @@ description: | `/v2/registry/example/repositories/my%2Frepo/tags/mytag`. A successful request will receive a 204 status code with no body in response. - This indicates that the request was processed successfully. It is similar to DELETE `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags/$TAG` and exists for backward compatibility. + This indicates that the request was processed successfully. It is similar to DELETE `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags/$TAG`. tags: - Container Registries diff --git a/specification/resources/registry/registries_get.yml b/specification/resources/registry/registries_get.yml index b70d8fe54..41d9264e5 100644 --- a/specification/resources/registry/registries_get.yml +++ b/specification/resources/registry/registries_get.yml @@ -1,6 +1,6 @@ operationId: registries_get -summary: "[Public Preview] Get a Container Registry By Name" +summary: "Get a Container Registry By Name" description: To get information about any container registry in your account, send a GET request to `/v2/registries/{registry_name}`. diff --git a/specification/resources/registry/registries_get_all.yml b/specification/resources/registry/registries_get_all.yml index 1270115db..f581727ee 100644 --- a/specification/resources/registry/registries_get_all.yml +++ b/specification/resources/registry/registries_get_all.yml @@ -1,6 +1,6 @@ operationId: registries_list -summary: "[Public Preview] List All Container Registries" +summary: "List All Container Registries" description: To get information about any container registry in your account, send a GET request to `/v2/registries/`. diff --git a/specification/resources/registry/registries_get_dockerCredentials.yml b/specification/resources/registry/registries_get_dockerCredentials.yml index bd70dded1..e98b86ff5 100644 --- a/specification/resources/registry/registries_get_dockerCredentials.yml +++ b/specification/resources/registry/registries_get_dockerCredentials.yml @@ -1,6 +1,6 @@ operationId: registries_get_dockerCredentials -summary: "[Public Preview] Get Docker Credentials By Registry Name" +summary: "Get Docker Credentials By Registry Name" description: | In order to access your container registry with the Docker client or from a diff --git a/specification/resources/registry/registries_get_garbageCollection.yml b/specification/resources/registry/registries_get_garbageCollection.yml index 8ab2bd509..99af3cb95 100644 --- a/specification/resources/registry/registries_get_garbageCollection.yml +++ b/specification/resources/registry/registries_get_garbageCollection.yml @@ -1,6 +1,6 @@ operationId: registries_get_garbageCollection -summary: "[Public Preview] Get Active Garbage Collection" +summary: "Get Active Garbage Collection" description: To get information about the currently-active garbage collection for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collection`. diff --git a/specification/resources/registry/registries_get_options.yml b/specification/resources/registry/registries_get_options.yml index 377f7b1a3..81c86cbc1 100644 --- a/specification/resources/registry/registries_get_options.yml +++ b/specification/resources/registry/registries_get_options.yml @@ -1,6 +1,6 @@ operationId: registries_get_options -summary: "[Public Preview] List Registry Options (Subscription Tiers and Available Regions)" +summary: "List Registry Options (Subscription Tiers and Available Regions)" description: >- This endpoint serves to provide additional information as to which option values @@ -14,7 +14,7 @@ description: >- where your data is stored. To list the available options, send a GET request to - `/v2/registries/options`. This is similar to GET `/v2/registry/options` and exists for backward compatibility. + `/v2/registries/options`. This is similar to GET `/v2/registry/options`. tags: - Container Registries diff --git a/specification/resources/registry/registries_get_subscription.yml b/specification/resources/registry/registries_get_subscription.yml index 0d2cca3f5..368434081 100644 --- a/specification/resources/registry/registries_get_subscription.yml +++ b/specification/resources/registry/registries_get_subscription.yml @@ -1,10 +1,10 @@ operationId: registries_get_subscription -summary: "[Public Preview] Get Subscription Information" +summary: "Get Subscription Information" description: A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET - request to `/v2/registries/subscription`. It is similar to GET `/v2/registry/subscription` and exists for backward compatibility. + request to `/v2/registries/subscription`. It is similar to GET `/v2/registry/subscription`. tags: - Container Registries diff --git a/specification/resources/registry/registries_list_garbageCollections.yml b/specification/resources/registry/registries_list_garbageCollections.yml index 79e8ce322..e38561dc7 100644 --- a/specification/resources/registry/registries_list_garbageCollections.yml +++ b/specification/resources/registry/registries_list_garbageCollections.yml @@ -1,6 +1,6 @@ operationId: registries_list_garbageCollections -summary: "[Public Preview] List Garbage Collections" +summary: "List Garbage Collections" description: To get information about past garbage collections for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. diff --git a/specification/resources/registry/registries_list_repositoriesV2.yml b/specification/resources/registry/registries_list_repositoriesV2.yml index 92ae29bb1..14591f359 100644 --- a/specification/resources/registry/registries_list_repositoriesV2.yml +++ b/specification/resources/registry/registries_list_repositoriesV2.yml @@ -1,9 +1,9 @@ operationId: registries_list_repositoriesV2 -summary: "[Public Preview] List All Container Registry Repositories (V2)" +summary: "List All Container Registry Repositories (V2)" description: To list all repositories in your container registry, send a GET - request to `/v2/registries/$REGISTRY_NAME/repositoriesV2`. It is similar to GET `/v2/registry/$REGISTRY_NAME/repositoriesV2` and exists for backward compatibility. + request to `/v2/registries/$REGISTRY_NAME/repositoriesV2`. It is similar to GET `/v2/registry/$REGISTRY_NAME/repositoriesV2`. tags: - Container Registries diff --git a/specification/resources/registry/registries_list_repositoryManifests.yml b/specification/resources/registry/registries_list_repositoryManifests.yml index 2c0af01d5..31c815498 100644 --- a/specification/resources/registry/registries_list_repositoryManifests.yml +++ b/specification/resources/registry/registries_list_repositoryManifests.yml @@ -1,6 +1,6 @@ operationId: registries_list_repositoryManifests -summary: "[Public Preview] List All Container Registry Repository Manifests" +summary: "List All Container Registry Repository Manifests" description: | To list all manifests in your container registry repository, send a GET @@ -11,7 +11,7 @@ description: | `registry.digitalocean.com/example/my/repo`, the path would be `/v2/registry/example/repositories/my%2Frepo/digests`. - It is similar to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests` and exists for backward compatibility. + It is similar to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`. tags: - Container Registries diff --git a/specification/resources/registry/registries_list_repositoryTags.yml b/specification/resources/registry/registries_list_repositoryTags.yml index 8694e0f78..68a22a7fe 100644 --- a/specification/resources/registry/registries_list_repositoryTags.yml +++ b/specification/resources/registry/registries_list_repositoryTags.yml @@ -1,6 +1,6 @@ operationId: registries_list_repositoryTags -summary: "[Public Preview] List All Container Registry Repository Tags" +summary: "List All Container Registry Repository Tags" description: | To list all tags in one of your container registry's repository, send a GET @@ -11,7 +11,7 @@ description: | `registry.digitalocean.com/example/my/repo`, the path would be `/v2/registry/example/repositories/my%2Frepo/tags`. - It is similar to GET `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags` and exists for backward compatibility. + It is similar to GET `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`. tags: - Container Registries diff --git a/specification/resources/registry/registries_run_garbageCollection.yml b/specification/resources/registry/registries_run_garbageCollection.yml index 020364409..7c48db31e 100644 --- a/specification/resources/registry/registries_run_garbageCollection.yml +++ b/specification/resources/registry/registries_run_garbageCollection.yml @@ -1,6 +1,6 @@ operationId: registries_run_garbageCollection -summary: "[Public Preview] Start Garbage Collection" +summary: "Start Garbage Collection" description: | Garbage collection enables users to clear out unreferenced blobs (layer & diff --git a/specification/resources/registry/registries_update_garbageCollection.yml b/specification/resources/registry/registries_update_garbageCollection.yml index 7f8e6e452..950ef97ac 100644 --- a/specification/resources/registry/registries_update_garbageCollection.yml +++ b/specification/resources/registry/registries_update_garbageCollection.yml @@ -1,10 +1,10 @@ operationId: registries_update_garbageCollection -summary: "[Public Preview] Update Garbage Collection" +summary: "Update Garbage Collection" description: To cancel the currently-active garbage collection for a registry, send a PUT request to `/v2/registries/$REGISTRY_NAME/garbage-collection/$GC_UUID` - and specify one or more of the attributes below. It is similar to PUT `/v2/registries/$REGISTRY_NAME/garbage-collection/$GC_UUID` and exists for backward compatibility. + and specify one or more of the attributes below. It is similar to PUT `/v2/registries/$REGISTRY_NAME/garbage-collection/$GC_UUID`. tags: - Container Registries diff --git a/specification/resources/registry/registries_update_subscription.yml b/specification/resources/registry/registries_update_subscription.yml index 07e509dbe..75c7dcec3 100644 --- a/specification/resources/registry/registries_update_subscription.yml +++ b/specification/resources/registry/registries_update_subscription.yml @@ -1,10 +1,10 @@ operationId: registries_update_subscription -summary: "[Public Preview] Update Subscription Tier" +summary: "Update Subscription Tier" description: After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request - to `/v2/registries/subscription`. It is similar to POST `/v2/registry/subscription` and exists for backward compatibility. + to `/v2/registries/subscription`. It is similar to POST `/v2/registry/subscription`. tags: - Container Registries diff --git a/specification/resources/registry/registries_validate_name.yml b/specification/resources/registry/registries_validate_name.yml index 651fd3361..5d3b12527 100644 --- a/specification/resources/registry/registries_validate_name.yml +++ b/specification/resources/registry/registries_validate_name.yml @@ -1,6 +1,6 @@ operationId: registries_validate_name -summary: "[Public Preview] Validate a Container Registry Name" +summary: "Validate a Container Registry Name" description: | To validate that a container registry name is available for use, send a POST @@ -10,7 +10,7 @@ description: | be 204 and contain no body. If the name is already in use, the response will be a 409 Conflict. - It is similar to `/v2/registry/validate-name` and exists for backward compatibility. + It is similar to `/v2/registry/validate-name`. tags: - Container Registries diff --git a/specification/resources/registry/registry_create.yml b/specification/resources/registry/registry_create.yml index f7477b8cb..3bb613865 100644 --- a/specification/resources/registry/registry_create.yml +++ b/specification/resources/registry/registry_create.yml @@ -1,8 +1,11 @@ operationId: registry_create -summary: Create Container Registry +deprecated: true +summary: 'Create Container Registry' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + To create your container registry, send a POST request to `/v2/registry`. The `name` becomes part of the URL for images stored in the registry. For diff --git a/specification/resources/registry/registry_delete.yml b/specification/resources/registry/registry_delete.yml index e11b6052e..594c9db62 100644 --- a/specification/resources/registry/registry_delete.yml +++ b/specification/resources/registry/registry_delete.yml @@ -1,8 +1,12 @@ operationId: registry_delete -summary: Delete Container Registry +deprecated: true -description: To delete your container registry, destroying all container image +summary: 'Delete Container Registry' +description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + + To delete your container registry, destroying all container image data stored in it, send a DELETE request to `/v2/registry`. This operation is not compatible with multiple registries in a DO account. You should use `/v2/registries/{registry_name}` instead. diff --git a/specification/resources/registry/registry_delete_repositoryManifest.yml b/specification/resources/registry/registry_delete_repositoryManifest.yml index d6078ead8..da0362354 100644 --- a/specification/resources/registry/registry_delete_repositoryManifest.yml +++ b/specification/resources/registry/registry_delete_repositoryManifest.yml @@ -1,8 +1,11 @@ operationId: registry_delete_repositoryManifest -summary: Delete Container Registry Repository Manifest +deprecated: true +summary: 'Delete Container Registry Repository Manifest' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + To delete a container repository manifest by digest, send a DELETE request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests/$MANIFEST_DIGEST`. diff --git a/specification/resources/registry/registry_delete_repositoryTag.yml b/specification/resources/registry/registry_delete_repositoryTag.yml index 3fbf68156..b4841b0f5 100644 --- a/specification/resources/registry/registry_delete_repositoryTag.yml +++ b/specification/resources/registry/registry_delete_repositoryTag.yml @@ -1,8 +1,11 @@ operationId: registry_delete_repositoryTag -summary: Delete Container Registry Repository Tag +deprecated: true +summary: 'Delete Container Registry Repository Tag' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + To delete a container repository tag, send a DELETE request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags/$TAG`. diff --git a/specification/resources/registry/registry_get.yml b/specification/resources/registry/registry_get.yml index 6ae01067a..eb64c2d5b 100644 --- a/specification/resources/registry/registry_get.yml +++ b/specification/resources/registry/registry_get.yml @@ -1,8 +1,12 @@ operationId: registry_get -summary: Get Container Registry Information +deprecated: true -description: To get information about your container registry, send a GET +summary: 'Get Container Registry Information' +description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + + To get information about your container registry, send a GET request to `/v2/registry`. This operation is not compatible with multiple registries in a DO account. You should use `/v2/registries/{registry_name}` instead. diff --git a/specification/resources/registry/registry_get_dockerCredentials.yml b/specification/resources/registry/registry_get_dockerCredentials.yml index a5e3d778d..46e4e5114 100644 --- a/specification/resources/registry/registry_get_dockerCredentials.yml +++ b/specification/resources/registry/registry_get_dockerCredentials.yml @@ -1,8 +1,11 @@ operationId: registry_get_dockerCredentials -summary: Get Docker Credentials for Container Registry +deprecated: true +summary: 'Get Docker Credentials for Container Registry' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + In order to access your container registry with the Docker client or from a Kubernetes cluster, you will need to configure authentication. The necessary JSON configuration can be retrieved by sending a GET request to diff --git a/specification/resources/registry/registry_get_garbageCollection.yml b/specification/resources/registry/registry_get_garbageCollection.yml index fce654c18..2f69c9cb5 100644 --- a/specification/resources/registry/registry_get_garbageCollection.yml +++ b/specification/resources/registry/registry_get_garbageCollection.yml @@ -1,8 +1,12 @@ operationId: registry_get_garbageCollection -summary: Get Active Garbage Collection +deprecated: true -description: To get information about the currently-active garbage collection +summary: 'Get Active Garbage Collection' +description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + + To get information about the currently-active garbage collection for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collection`. tags: diff --git a/specification/resources/registry/registry_get_options.yml b/specification/resources/registry/registry_get_options.yml index 306b82146..d398a09b2 100644 --- a/specification/resources/registry/registry_get_options.yml +++ b/specification/resources/registry/registry_get_options.yml @@ -1,8 +1,11 @@ operationId: registry_get_options -summary: List Registry Options (Subscription Tiers and Available Regions) +deprecated: true + +summary: 'List Registry Options (Subscription Tiers and Available Regions)' +description: | + **Note: This endpoint is deprecated and may be removed in a future version. There is no alternative.****Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** -description: >- This endpoint serves to provide additional information as to which option values are available when creating a container registry. diff --git a/specification/resources/registry/registry_get_subscription.yml b/specification/resources/registry/registry_get_subscription.yml index c0ecae454..c721fc991 100644 --- a/specification/resources/registry/registry_get_subscription.yml +++ b/specification/resources/registry/registry_get_subscription.yml @@ -1,8 +1,12 @@ operationId: registry_get_subscription -summary: Get Subscription Information +deprecated: true -description: A subscription is automatically created when you configure your +summary: 'Get Subscription' +description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + + A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to `/v2/registry/subscription`. diff --git a/specification/resources/registry/registry_list_garbageCollections.yml b/specification/resources/registry/registry_list_garbageCollections.yml index 69ffe66fb..34065e8a7 100644 --- a/specification/resources/registry/registry_list_garbageCollections.yml +++ b/specification/resources/registry/registry_list_garbageCollections.yml @@ -1,8 +1,12 @@ operationId: registry_list_garbageCollections -summary: List Garbage Collections +deprecated: true -description: To get information about past garbage collections for a registry, +summary: 'List Garbage Collections' +description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + + To get information about past garbage collections for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. tags: diff --git a/specification/resources/registry/registry_list_repositories.yml b/specification/resources/registry/registry_list_repositories.yml index f47013883..8c2c4e1df 100644 --- a/specification/resources/registry/registry_list_repositories.yml +++ b/specification/resources/registry/registry_list_repositories.yml @@ -2,9 +2,10 @@ operationId: registry_list_repositories deprecated: true -summary: List All Container Registry Repositories - +summary: 'List All Container Registry Repositories' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + This endpoint has been deprecated in favor of the _List All Container Registry Repositories [V2]_ endpoint. To list all repositories in your container registry, send a GET diff --git a/specification/resources/registry/registry_list_repositoriesV2.yml b/specification/resources/registry/registry_list_repositoriesV2.yml index 81ebb19b7..524078654 100644 --- a/specification/resources/registry/registry_list_repositoriesV2.yml +++ b/specification/resources/registry/registry_list_repositoriesV2.yml @@ -1,8 +1,12 @@ operationId: registry_list_repositoriesV2 -summary: List All Container Registry Repositories (V2) +deprecated: true -description: To list all repositories in your container registry, send a GET +summary: 'List All Container Registry Repositories (V2)' +description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + + To list all repositories in your container registry, send a GET request to `/v2/registry/$REGISTRY_NAME/repositoriesV2`. tags: diff --git a/specification/resources/registry/registry_list_repositoryManifests.yml b/specification/resources/registry/registry_list_repositoryManifests.yml index 909a50b83..ccfdc8a7c 100644 --- a/specification/resources/registry/registry_list_repositoryManifests.yml +++ b/specification/resources/registry/registry_list_repositoryManifests.yml @@ -1,8 +1,11 @@ operationId: registry_list_repositoryManifests -summary: List All Container Registry Repository Manifests +deprecated: true +summary: 'List All Container Registry Repository Manifests' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + To list all manifests in your container registry repository, send a GET request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`. diff --git a/specification/resources/registry/registry_list_repositoryTags.yml b/specification/resources/registry/registry_list_repositoryTags.yml index 70d0276ff..99f875d57 100644 --- a/specification/resources/registry/registry_list_repositoryTags.yml +++ b/specification/resources/registry/registry_list_repositoryTags.yml @@ -1,8 +1,11 @@ operationId: registry_list_repositoryTags -summary: List All Container Registry Repository Tags +deprecated: true +summary: 'List All Container Registry Repository Tags' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + To list all tags in your container registry repository, send a GET request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`. diff --git a/specification/resources/registry/registry_run_garbageCollection.yml b/specification/resources/registry/registry_run_garbageCollection.yml index 26492652c..22bcfe0fc 100644 --- a/specification/resources/registry/registry_run_garbageCollection.yml +++ b/specification/resources/registry/registry_run_garbageCollection.yml @@ -1,8 +1,11 @@ operationId: registry_run_garbageCollection -summary: Start Garbage Collection +deprecated: true +summary: 'Start Garbage Collection' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + Garbage collection enables users to clear out unreferenced blobs (layer & manifest data) after deleting one or more manifests from a repository. If there are no unreferenced blobs resulting from the deletion of one or more diff --git a/specification/resources/registry/registry_update_garbageCollection.yml b/specification/resources/registry/registry_update_garbageCollection.yml index 9de2dcd5e..448c4ddc1 100644 --- a/specification/resources/registry/registry_update_garbageCollection.yml +++ b/specification/resources/registry/registry_update_garbageCollection.yml @@ -1,8 +1,12 @@ operationId: registry_update_garbageCollection -summary: Update Garbage Collection +deprecated: true -description: To cancel the currently-active garbage collection for a registry, +summary: 'Update Garbage Collection' +description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + + To cancel the currently-active garbage collection for a registry, send a PUT request to `/v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID` and specify one or more of the attributes below. diff --git a/specification/resources/registry/registry_update_subscription.yml b/specification/resources/registry/registry_update_subscription.yml index f25774653..199c92ae6 100644 --- a/specification/resources/registry/registry_update_subscription.yml +++ b/specification/resources/registry/registry_update_subscription.yml @@ -1,8 +1,12 @@ operationId: registry_update_subscription -summary: Update Subscription Tier +deprecated: true -description: After creating your registry, you can switch to a different +summary: 'Update Subscription Tier' +description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + + After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request to `/v2/registry/subscription`. diff --git a/specification/resources/registry/registry_validate_name.yml b/specification/resources/registry/registry_validate_name.yml index 1384aef0c..415d04359 100644 --- a/specification/resources/registry/registry_validate_name.yml +++ b/specification/resources/registry/registry_validate_name.yml @@ -1,8 +1,11 @@ operationId: registry_validate_name -summary: Validate a Container Registry Name +deprecated: true +summary: 'Validate a Container Registry Name' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + To validate that a container registry name is available for use, send a POST request to `/v2/registry/validate-name`.