Skip to content

Commit 77596f7

Browse files
stevsmitSteven Smith
and
Steven Smith
authored
Adds tag API commands (#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

+1-1
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

+2
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

+1-1
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

+1-1
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

+2-2
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

+1-1
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

+6-6
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

+4-4
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

+1-1
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

+9
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+
----

modules/automating-quay-using-the-api.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The following example shows you how you might use a Python script and a cron job
1616
1717
.Procedure
1818

19-
. Create a Python script that executes an API command. The following example is used to delete organization applications using the link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#deleteorganizationapplication[`DELETE /api/v1/organization/{orgname}/applications/{client_id}`] API endpoint.
19+
. Create a Python script that executes an API command. The following example is used to delete organization applications using the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#deleteorganizationapplication[`DELETE /api/v1/organization/{orgname}/applications/{client_id}`] API endpoint.
2020
+
2121
.example.py file
2222
[source,python]

modules/clair-troubleshooting-issues.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ Use the following procedures to troubleshoot Clair.
99

1010
If you are using Clair, ensure that the images you are trying to scan are supported by Clair. Clair has certain requirements and does not support all image formats or configurations.
1111

12-
For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/manage_red_hat_quay/clair-vulnerability-scanner#clair-vulnerability-scanner-hosts[Clair vulnerability databases].
12+
For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html/manage_red_hat_quay/clair-vulnerability-scanner#clair-vulnerability-scanner-hosts[Clair vulnerability databases].
1313

1414
[id="allowlist-clair-updaters"]
1515
== Allowlisting Clair updaters
1616

17-
If you are using Clair behind a proxy configuration, you must allowlist the updaters in your proxy or firewall configuration. For more information about updater URLs, see link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/vulnerability_reporting_with_clair_on_red_hat_quay/clair-concepts#clair-updater-urls[Clair updater URLs].
17+
If you are using Clair behind a proxy configuration, you must allowlist the updaters in your proxy or firewall configuration. For more information about updater URLs, see link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html/vulnerability_reporting_with_clair_on_red_hat_quay/clair-concepts#clair-updater-urls[Clair updater URLs].
1818

1919
[id="clair-dependencies-update"]
2020
== Updating Clair scanner and its dependencies
@@ -114,7 +114,7 @@ log_level: debug
114114
[id="checking-clair-configuration"]
115115
== Checking Clair configuration
116116

117-
Check your Clair `config.yaml` file to ensure that there are no misconfigurations or inconsistencies that could lead to issues. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html-single/vulnerability_reporting_with_clair_on_red_hat_quay/index#config-fields-overview[Clair configuration overview].
117+
Check your Clair `config.yaml` file to ensure that there are no misconfigurations or inconsistencies that could lead to issues. For more information, see link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/vulnerability_reporting_with_clair_on_red_hat_quay/index#config-fields-overview[Clair configuration overview].
118118

119119
[id="inspect-image-metadata"]
120120
== Inspect image metadata

modules/clairv4-air-gapped.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@
77
* On a system with internet access, the vulnerability database updates is performed manually and exported to a disk.
88
* The on-disk data is then transferred to the target system with offline media. It is then manually imported.
99

10-
For more information on air-gapped Clair v4 and using `clairctl`, the command line tool, see https://access.redhat.com/documentation/en-us/red_hat_quay/3/html/deploy_red_hat_quay_on_openshift_with_the_quay_operator/quay_operator_features#clair-disconnected-environments[Manually updating the vulnerability databases for Clair in an air-gapped OpenShift cluster]
10+
For more information on air-gapped Clair v4 and using `clairctl`, the command line tool, see https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html/deploy_red_hat_quay_on_openshift_with_the_quay_operator/quay_operator_features#clair-disconnected-environments[Manually updating the vulnerability databases for Clair in an air-gapped OpenShift cluster]

modules/con_quay_intro.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* Zero downtime garbage collection
1515
* 24/7 support
1616
17-
Users should check the link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html-single/red_hat_quay_release_notes/index#doc-wrapper[{productname} Release Notes] for the latest feature information.
17+
Users should check the link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/red_hat_quay_release_notes/index#doc-wrapper[{productname} Release Notes] for the latest feature information.
1818

1919
[id="poc-support"]
2020
= {productname} support
@@ -32,7 +32,7 @@ Users should check the link:https://access.redhat.com/documentation/en-us/red_ha
3232

3333
{productname} includes several core components, both internal and external.
3434

35-
For a fuller architectural breakdown, see the link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html-single/red_hat_quay_architecture/index[{productname} architecture] guide.
35+
For a fuller architectural breakdown, see the link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/red_hat_quay_architecture/index[{productname} architecture] guide.
3636

3737
[id="poc-internal-components"]
3838
=== Internal components

modules/con_schema.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
[id="quay-schema"]
33
= Schema for {productname} configuration
44

5-
Most {productname} configuration information is stored in the `config.yaml` file. All configuration options are described in the link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html-single/configure_red_hat_quay/index#doc-wrapper[{productname} Configuration Guide].
5+
Most {productname} configuration information is stored in the `config.yaml` file. All configuration options are described in the link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/configure_red_hat_quay/index#doc-wrapper[{productname} Configuration Guide].

modules/config-disclaimer.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44

55
With both standalone and Operator-based deployments of {productname} certain features and configuration parameters are not actively used or implemented. As a result, feature flags, such as those that enable or disable certain features, and configuration parameters that are not explicitly documented or requested for documentation by Red Hat Support, should only be modified with caution. Unused features or parameters might not be fully tested, supported, or compatible with {productname}. Modifying unused features parameters might lead to unexpected issues or disruptions with your deployment.
66

7-
For information about configuring {productname} in standalone deployments, see link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html-single/manage_red_hat_quay/index#advanced-quay-configuration[Advanced {productname} configuration]
7+
For information about configuring {productname} in standalone deployments, see link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/manage_red_hat_quay/index#advanced-quay-configuration[Advanced {productname} configuration]
88

9-
For information about configuring {productname} Operator deployments, see link:https://access.redhat.com/documentation/en-us/red_hat_quay/3/html-single/deploying_the_red_hat_quay_operator_on_openshift_container_platform/index#operator-config-cli[Configuring {productname} on {ocp}]
9+
For information about configuring {productname} Operator deployments, see link:https://access.redhat.com/documentation/en-us/red_hat_quay/{producty}/html-single/deploying_the_red_hat_quay_operator_on_openshift_container_platform/index#operator-config-cli[Configuring {productname} on {ocp}]

0 commit comments

Comments
 (0)