Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ source: |-

req = {
"name": "example",
"region": "fra1"
"region": "fra1",
"subscription_tier_slug": "basic"
}

resp = client.registries.create(body=req)
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ operationId: registries_list_repositoriesV2
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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 4 additions & 1 deletion specification/resources/registry/registry_create.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 6 additions & 2 deletions specification/resources/registry/registry_delete.yml
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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`.

Expand Down
Original file line number Diff line number Diff line change
@@ -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`.

Expand Down
8 changes: 6 additions & 2 deletions specification/resources/registry/registry_get.yml
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
7 changes: 5 additions & 2 deletions specification/resources/registry/registry_get_options.yml
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Original file line number Diff line number Diff line change
@@ -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`.

Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Original file line number Diff line number Diff line change
@@ -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`.

Expand Down
Original file line number Diff line number Diff line change
@@ -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`.

Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Original file line number Diff line number Diff line change
@@ -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`.

Expand Down
5 changes: 4 additions & 1 deletion specification/resources/registry/registry_validate_name.yml
Original file line number Diff line number Diff line change
@@ -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`.

Expand Down