Skip to content

Commit 307fc1c

Browse files
stevsmitSteven Smith
stevsmit
and
Steven Smith
authored
Updates Clair API heading (#1060) (#1063)
Co-authored-by: Steven Smith <stevsmit@stevsmit-thinkpadt14gen4.remote.csb>
1 parent 5c63820 commit 307fc1c

File tree

54 files changed

+517
-14
lines changed

Some content is hidden

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

54 files changed

+517
-14
lines changed

‎modules/adding-managing-labels-api.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -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/3/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/api-logs-exportOrgLogs.adoc

+16
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,19 @@ _optional_|The e-mail address at which to e-mail a link to the exported logs|str
6161
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
6262
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
6363
|===
64+
65+
[discrete]
66+
== Example command
67+
[source,terminal]
68+
----
69+
$ curl -X POST \
70+
-H "Authorization: Bearer <bearer_token>" \
71+
-H "Content-Type: application/json" \
72+
-H "Accept: application/json" \
73+
-d '{
74+
"starttime": "<MM/DD/YYYY>",
75+
"endtime": "<MM/DD/YYYY>",
76+
"callback_email": "org.logs@example.com"
77+
}' \
78+
"http://<quay-server.example.com>/api/v1/organization/{orgname}/exportlogs"
79+
----

‎modules/api-logs-exportRepoLogs.adoc

+16
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,19 @@ _optional_|The e-mail address at which to e-mail a link to the exported logs|str
6161
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
6262
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
6363
|===
64+
65+
[discrete]
66+
== Example command
67+
[source,terminal]
68+
----
69+
$ curl -X POST \
70+
-H "Authorization: Bearer <bearer_token>" \
71+
-H "Content-Type: application/json" \
72+
-H "Accept: application/json" \
73+
-d '{
74+
"starttime": "2024-01-01",
75+
"endtime": "2024-06-18",
76+
"callback_url": "http://your-callback-url.example.com"
77+
}' \
78+
"http://<quay-server.example.com>/api/v1/repository/{repository}/exportlogs"
79+
----

‎modules/api-logs-exportUserLogs.adoc

+16
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,19 @@ _optional_|The e-mail address at which to e-mail a link to the exported logs|str
5151
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
5252
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
5353
|===
54+
55+
[discrete]
56+
== Example command
57+
[source,terminal]
58+
----
59+
$ curl -X POST \
60+
-H "Authorization: Bearer <bearer_token>" \
61+
-H "Content-Type: application/json" \
62+
-H "Accept: application/json" \
63+
-d '{
64+
"starttime": "<MM/DD/YYYY>",
65+
"endtime": "<MM/DD/YYYY>",
66+
"callback_email": "your.email@example.com"
67+
}' \
68+
"http://<quay-server.example.com>/api/v1/user/exportlogs"
69+
----

‎modules/api-logs-getAggregateOrgLogs.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,13 @@ _optional_|Earliest time for logs. Format: "%m/%d/%Y" in UTC.|string
4848
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
4949
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
5050
|===
51+
52+
[discrete]
53+
== Example command
54+
[source,terminal]
55+
----
56+
$ curl -X GET \
57+
-H "Authorization: Bearer <bearer_token>" \
58+
-H "Accept: application/json" \
59+
"<quay-server.example.com>/api/v1/organization/{orgname}/aggregatelogs"
60+
----

‎modules/api-logs-getAggregateRepoLogs.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,13 @@ _optional_|Earliest time for logs. Format: "%m/%d/%Y" in UTC.|string
4646
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
4747
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
4848
|===
49+
50+
[discrete]
51+
== Example command
52+
[source,terminal]
53+
----
54+
$ curl -X GET \
55+
-H "Authorization: Bearer <bearer_token>" \
56+
-H "Accept: application/json" \
57+
"<quay-server.example.com>/api/v1/repository/<repository_name>/<namespace>/aggregatelogs?starttime=2024-01-01&endtime=2024-06-18""
58+
----

‎modules/api-logs-getAggregateUserLogs.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,13 @@ _optional_|Earliest time for logs. Format: "%m/%d/%Y" in UTC.|string
3838
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
3939
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
4040
|===
41+
42+
[discrete]
43+
== Example command
44+
[source,terminal]
45+
----
46+
$ curl -X GET \
47+
-H "Authorization: Bearer <bearer_token>" \
48+
-H "Accept: application/json" \
49+
"<quay-server.example.com>/api/v1/user/aggregatelogs?performer=<username>&starttime=<MM/DD/YYYY>&endtime=<MM/DD/YYYY>"
50+
----

‎modules/api-logs-listOrgLogs.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,13 @@ _optional_|Earliest time for logs. Format: "%m/%d/%Y" in UTC.|string
5050
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
5151
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
5252
|===
53+
54+
[discrete]
55+
== Example command
56+
[source,terminal]
57+
----
58+
$ curl -X GET \
59+
-H "Authorization: Bearer <bearer_token>" \
60+
-H "Accept: application/json" \
61+
"http://<quay-server.example.com>/api/v1/organization/{orgname}/logs"
62+
----

‎modules/api-logs-listRepoLogs.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,13 @@ _optional_|Earliest time for logs. Format: "%m/%d/%Y" in UTC.|string
4848
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
4949
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
5050
|===
51+
52+
[discrete]
53+
== Example command
54+
[source,terminal]
55+
----
56+
$ curl -X GET \
57+
-H "Authorization: Bearer <bearer_token>" \
58+
-H "Accept: application/json" \
59+
"http://<quay-server.example.com>/api/v1/repository/{repository}/logs"
60+
----

‎modules/api-logs-listUserLogs.adoc

+7
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,10 @@ _optional_|Earliest time for logs. Format: "%m/%d/%Y" in UTC.|string
4040
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
4141
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
4242
|===
43+
44+
[discrete]
45+
== Example command
46+
[source,terminal]
47+
----
48+
$ curl -X GET -H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY" -H "Accept: application/json" "quay-server.example.com/api/v1/user/logs"
49+
----

‎modules/api-manifest-addManifestLabel.adoc

+15
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,18 @@ _required_|The media type for this label|
5252
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
5353
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
5454
|===
55+
56+
[discrete]
57+
== Example command
58+
[source,terminal]
59+
----
60+
$ curl -X POST \
61+
-H "Authorization: Bearer <bearer_token>" \
62+
-H "Content-Type: application/json" \
63+
--data '{
64+
"key": "<key>",
65+
"value": "<value>",
66+
"media_type": "<media_type>"
67+
}' \
68+
https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>/labels
69+
----

‎modules/api-manifest-deleteManifestLabel.adoc

+9
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,12 @@ _required_|The ID of the label|string
3737
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
3838
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
3939
|===
40+
41+
[discrete]
42+
== Example command
43+
[source,terminal]
44+
----
45+
$ curl -X DELETE \
46+
-H "Authorization: Bearer <bearer_token>" \
47+
https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>/labels/<labelid>
48+
----

‎modules/api-manifest-getManifestLabel.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,13 @@ _required_|The ID of the label|string
3737
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
3838
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
3939
|===
40+
41+
[discrete]
42+
== Example command
43+
[source,terminal]
44+
----
45+
$ curl -X GET \
46+
-H "Authorization: Bearer <bearer_token>" \
47+
-H "Accept: application/json" \
48+
https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>/labels/<label_id>
49+
----

‎modules/api-manifest-getRepoManifest.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,13 @@ _required_|The digest of the manifest|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+
[source,terminal]
42+
----
43+
$ curl -X GET \
44+
-H "Authorization: Bearer <bearer_token>" \
45+
-H "Accept: application/json" \
46+
https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>
47+
----

‎modules/api-manifest-listManifestLabels.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,13 @@ _optional_|If specified, only labels matching the given prefix will be returned|
4646
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
4747
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
4848
|===
49+
50+
[discrete]
51+
== Example command
52+
[source,terminal]
53+
----
54+
$ curl -X GET \
55+
-H "Authorization: Bearer <bearer_token>" \
56+
-H "Accept: application/json" \
57+
https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>/labels
58+
----

‎modules/api-organization-deleteAdminedOrganization.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,13 @@ _required_|The name of the organization|string
3333
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
3434
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
3535
|===
36+
37+
[discrete]
38+
== Example command
39+
40+
[source,terminal]
41+
----
42+
$ curl -X GET \
43+
-H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY" \
44+
"<quay-server.example.com>/api/v1/organization/<organization_name>"
45+
----

‎modules/api-permission-changeUserPermissions.adoc

+12
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,15 @@ _required_|Role to use for the user|string
4848
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
4949
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
5050
|===
51+
52+
[discrete]
53+
== Example command
54+
55+
[source,terminal]
56+
----
57+
$ curl -X PUT \
58+
-H "Authorization: Bearer <bearer_token>" \
59+
-H "Content-Type: application/json" \
60+
-d '{"role": "admin"}' \
61+
https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>
62+
----

‎modules/api-permission-deleteUserPermissions.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,13 @@ _required_|The full path of the repository. e.g. namespace/name|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+
[source,terminal]
42+
----
43+
$ curl -X DELETE \
44+
-H "Authorization: Bearer <bearer_token>" \
45+
-H "Accept: application/json" \
46+
https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>
47+
----

‎modules/api-permission-listRepoUserPermissions.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,14 @@ _required_|The full path of the repository. e.g. namespace/name|string
3333
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
3434
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
3535
|===
36+
37+
[discrete]
38+
== Example command
39+
40+
[source,terminal]
41+
----
42+
$ curl -X GET \
43+
-H "Authorization: Bearer <bearer_token>" \
44+
-H "Accept: application/json" \
45+
https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>/
46+
----

‎modules/api-prototype-createOrganizationPrototypePermission.adoc

+17
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,20 @@ _required_|Information about the user or team to which the rule grants access|ob
5050
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
5151
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
5252
|===
53+
54+
[discrete]
55+
== Example command
56+
57+
[source,terminal]
58+
----
59+
$ curl -X POST -H "Authorization: Bearer <bearer_token>" -H "Content-Type: application/json" --data '{
60+
"role": "<admin_read_or_write>",
61+
"delegate": {
62+
"name": "<username>",
63+
"kind": "user"
64+
},
65+
"activating_user": {
66+
"name": "<robot_name>"
67+
}
68+
}' https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes
69+
----

‎modules/api-prototype-deleteOrganizationPrototypePermission.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,13 @@ _required_|The name of the organization|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+
[source,terminal]
42+
----
43+
curl -X DELETE \
44+
-H "Authorization: Bearer <bearer_token>" \
45+
-H "Accept: application/json" \
46+
https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes/<prototype_id>
47+
----

‎modules/api-prototype-getOrganizationPrototypePermissions.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,14 @@ _required_|The name of the organization|string
3333
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
3434
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
3535
|===
36+
37+
[discrete]
38+
== Example command
39+
40+
[source,terminal]
41+
----
42+
$ curl -X GET \
43+
-H "Authorization: Bearer <bearer_token>" \
44+
-H "Accept: application/json" \
45+
https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes
46+
----

‎modules/api-prototype-updateOrganizationPrototypePermission.adoc

+13
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,16 @@ _optional_|Role that should be applied to the permission|string
4848
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
4949
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
5050
|===
51+
52+
[discrete]
53+
== Example command
54+
[source,terminal]
55+
----
56+
$ curl -X PUT \
57+
-H "Authorization: Bearer <bearer_token>" \
58+
-H "Content-Type: application/json" \
59+
--data '{
60+
"role": "write"
61+
}' \
62+
https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes/<prototypeid>
63+
----

‎modules/api-repository-deleteRepository.adoc

+8
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,11 @@ _required_|The full path of the repository. e.g. namespace/name|string
3333
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
3434
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
3535
|===
36+
37+
[discrete]
38+
== Example command
39+
40+
[source,terminal]
41+
----
42+
$ curl -X DELETE -H "Authorization: Bearer <bearer_token>" "quay-server.example.com/api/v1/repository/<namespace>/<repository_name>"
43+
----

‎modules/api-repository-getRepo.adoc

+8
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,11 @@ _optional_|Whether to include action statistics|boolean
4646
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
4747
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
4848
|===
49+
50+
[discrete]
51+
== Example command
52+
53+
[source,terminal]
54+
----
55+
$ curl -X GET -H "Authorization: Bearer <bearer_token>" "quay-server.example.com/api/v1/repository/<namespace>/<repository_name>"
56+
----

0 commit comments

Comments
 (0)