Skip to content

Commit 77596f7

Browse files
stevsmitSteven Smith
andauthored
Adds tag API commands (quay#1226)
Co-authored-by: Steven Smith <[email protected]>
1 parent 02461a9 commit 77596f7

File tree

85 files changed

+290
-212
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+290
-212
lines changed

README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ You can make content appear only in the upstream by using the `ifdef::upstream`
217217
ifdef::downstream[]
218218
== How do I make content appear in downstream but not in upstream?
219219

220-
You can make content appear only in the link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/[downstream] by using the `ifdef::downstream` conditional around the content that you only want to appear downstream. For example:
220+
You can make content appear only in the link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/[downstream] by using the `ifdef::downstream` conditional around the content that you only want to appear downstream. For example:
221221

222222
----
223223
\ifdef::downstream[]

api/master.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,8 @@ include::modules/listing-repos-superuser-api.adoc[leveloffset=+3]
119119
include::modules/managing-organization-quota-superuser-api.adoc[leveloffset=+3]
120120
include::modules/managing-user-quota-superuser-api.adoc[leveloffset=+3]
121121
include::modules/retrieving-build-info-superuser-api.adoc[leveloffset=+3]
122+
//tag
123+
include::modules/managing-tags-api.adoc[leveloffset=+2]
122124
123125
124126
include::modules/managing-service-keys-api.adoc[leveloffset=+3]

deploy_quay/master.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ include::modules/clair-cve.adoc[leveloffset=+3]
8484
8585
.Additional resources
8686
87-
* link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html-single/vulnerability_reporting_with_clair_on_red_hat_quay/index#vulnerability-reporting-clair-quay-overview[Vulnerability reporting with Clair on {productname}]
87+
* link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/vulnerability_reporting_with_clair_on_red_hat_quay/index#vulnerability-reporting-clair-quay-overview[Vulnerability reporting with Clair on {productname}]
8888
8989
include::modules/proc_deploy_quay_poc_restart.adoc[leveloffset=+2]
9090

deploy_quay_on_openshift_op_tng/master.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ include::modules/operator-unmanaged-redis.adoc[leveloffset=+1]
5454
[role="_additional-resources"]
5555
.Additional resources
5656

57-
xref:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html-single/configure_red_hat_quay/index#config-fields-redis[Redis configuration fields]
57+
xref:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/configure_red_hat_quay/index#config-fields-redis[Redis configuration fields]
5858

5959
include::modules/operator-unmanaged-hpa.adoc[leveloffset=+3]
6060
include::modules/operator-unmanaged-route.adoc[leveloffset=+3]

deploy_red_hat_quay_operator/master.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ include::modules/operator-unmanaged-redis.adoc[leveloffset=+3]
5151

5252
[role="_additional-resources"]
5353
.Additional resources
54-
link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html-single/configure_red_hat_quay/index#config-fields-redis[Redis configuration fields]
54+
link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/configure_red_hat_quay/index#config-fields-redis[Redis configuration fields]
5555

5656
include::modules/operator-unmanaged-hpa.adoc[leveloffset=+3]
5757
include::modules/operator-unmanaged-route.adoc[leveloffset=+3]
@@ -98,4 +98,4 @@ include::modules/creating-custom-ssl-certs-config-bundle.adoc[leveloffset=+2]
9898
[role="quay-next-steps"]
9999
.Next steps
100100

101-
* https://access.redhat.com/documentation/en-us/red_hat_quay/3/html-single/red_hat_quay_operator_features/[{productname} features]
101+
* https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/red_hat_quay_operator_features/[{productname} features]

modules/adding-a-new-tag-to-image-api.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ $ curl -X POST \
5151
{}
5252
----
5353

54-
. To see a list of tags after creating a new tag you can use the link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#listrepotags[`GET /api/v1/repository/{repository}/tag/`] command. For example:
54+
. To see a list of tags after creating a new tag you can use the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#listrepotags[`GET /api/v1/repository/{repository}/tag/`] command. For example:
5555
+
5656
[source,terminal]
5757
----

modules/adding-managing-labels-api.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66

77
.Prerequisites
88

9-
* You have link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#creating-oauth-access-token[Created an OAuth access token].
9+
* You have link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#creating-oauth-access-token[Created an OAuth access token].
1010
* You have set `BROWSER_API_CALLS_XHR_ONLY: false` in your `config.yaml` file.
1111
1212
.Procedure
1313

14-
. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#getrepomanifest[`GET /api/v1/repository/{repository}/manifest/{manifestref}`] command to retrieve the details of a specific manifest in a repository:
14+
. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#getrepomanifest[`GET /api/v1/repository/{repository}/manifest/{manifestref}`] command to retrieve the details of a specific manifest in a repository:
1515
+
1616
[source,terminal]
1717
----
@@ -21,7 +21,7 @@ $ curl -X GET \
2121
https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>
2222
----
2323

24-
. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#listmanifestlabels[`GET /api/v1/repository/{repository}/manifest/{manifestref}/labels`] command to retrieve a list of labels for a specific manifest:
24+
. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#listmanifestlabels[`GET /api/v1/repository/{repository}/manifest/{manifestref}/labels`] command to retrieve a list of labels for a specific manifest:
2525
+
2626
[source,terminal]
2727
----
@@ -38,7 +38,7 @@ $ curl -X GET \
3838
{"labels": [{"id": "e9f717d2-c1dd-4626-802d-733a029d17ad", "key": "org.opencontainers.image.url", "value": "https://github.com/docker-library/busybox", "source_type": "manifest", "media_type": "text/plain"}, {"id": "2d34ec64-4051-43ad-ae06-d5f81003576a", "key": "org.opencontainers.image.version", "value": "1.36.1-glibc", "source_type": "manifest", "media_type": "text/plain"}]}
3939
----
4040

41-
. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#getmanifestlabel[`GET /api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid}`] command to obtain information about a specific manifest:
41+
. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#getmanifestlabel[`GET /api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid}`] command to obtain information about a specific manifest:
4242
+
4343
[source,terminal]
4444
----
@@ -55,7 +55,7 @@ $ curl -X GET \
5555
{"id": "e9f717d2-c1dd-4626-802d-733a029d17ad", "key": "org.opencontainers.image.url", "value": "https://github.com/docker-library/busybox", "source_type": "manifest", "media_type": "text/plain"}
5656
----
5757

58-
. You can add an additional label to a manifest in a given repository with the link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#addmanifestlabel[`POST /api/v1/repository/{repository}/manifest/{manifestref}/labels`] command. For example:
58+
. You can add an additional label to a manifest in a given repository with the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#addmanifestlabel[`POST /api/v1/repository/{repository}/manifest/{manifestref}/labels`] command. For example:
5959
+
6060
[source,terminal]
6161
----
@@ -77,7 +77,7 @@ $ curl -X POST \
7777
{"label": {"id": "346593fd-18c8-49db-854f-4cb1fb76ff9c", "key": "example-key", "value": "example-value", "source_type": "api", "media_type": "text/plain"}}
7878
----
7979

80-
. You can delete a label using the link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#deletemanifestlabel[`DELETE /api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid}`] command:
80+
. You can delete a label using the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#deletemanifestlabel[`DELETE /api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid}`] command:
8181
+
8282
[source,terminal]
8383
----

modules/adjust-access-user-repo-api.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ Use the following procedure to adjust access settings for a user or robot accoun
1313
.Prerequisites
1414

1515
* You have created a user account or robot account.
16-
* You have link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#creating-oauth-access-token[Created an OAuth access token].
16+
* You have link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#creating-oauth-access-token[Created an OAuth access token].
1717
* You have set `BROWSER_API_CALLS_XHR_ONLY: false` in your `config.yaml` file.
1818
1919
.Procedure
2020

21-
. Enter the following link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#changeuserpermissions[`PUT /api/v1/repository/{repository}/permissions/user/{username}`] command to change the permissions of a user:
21+
. Enter the following link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#changeuserpermissions[`PUT /api/v1/repository/{repository}/permissions/user/{username}`] command to change the permissions of a user:
2222
+
2323
[source,terminal]
2424
----
@@ -36,7 +36,7 @@ $ curl -X PUT \
3636
{"role": "admin", "name": "quayadmin+test", "is_robot": true, "avatar": {"name": "quayadmin+test", "hash": "ca9afae0a9d3ca322fc8a7a866e8476dd6c98de543decd186ae090e420a88feb", "color": "#8c564b", "kind": "robot"}}
3737
----
3838

39-
. To delete the current permission, you can enter the link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#deleteuserpermissions[`DELETE /api/v1/repository/{repository}/permissions/user/{username}`] command:
39+
. To delete the current permission, you can enter the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#deleteuserpermissions[`DELETE /api/v1/repository/{repository}/permissions/user/{username}`] command:
4040
+
4141
[source,terminal]
4242
----
@@ -46,7 +46,7 @@ $ curl -X DELETE \
4646
https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>
4747
----
4848
+
49-
This command does not return any output in the CLI. Instead, you can check that the permissions were deleted by entering the link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#listrepouserpermissions[`GET /api/v1/repository/{repository}/permissions/user/`] command:
49+
This command does not return any output in the CLI. Instead, you can check that the permissions were deleted by entering the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#listrepouserpermissions[`GET /api/v1/repository/{repository}/permissions/user/`] command:
5050
+
5151
[source,terminal]
5252
----

modules/adjusting-repository-access-via-the-api.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The visibility of your repository can be set to `private` or `public` by using t
1111

1212
.Prerequisites
1313

14-
* You have link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#creating-oauth-access-token[Created an OAuth access token].
14+
* You have link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#creating-oauth-access-token[Created an OAuth access token].
1515
* You have set `BROWSER_API_CALLS_XHR_ONLY: false` in your `config.yaml` file.
1616
* You have created a repository.
1717

modules/api-tag-deleteFullTag.adoc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,12 @@ _required_|The name of the tag|string
3535
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
3636
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
3737
|===
38+
39+
[discrete]
40+
== Example command
41+
42+
[source,terminal]
43+
----
44+
$ curl -X DELETE "https://quay-server.example.com/api/v1/repository/<namespace>/<repo_name>/tag/<tag_name>" \
45+
-H "Authorization: Bearer <your_access_token>"
46+
----

0 commit comments

Comments
 (0)