Updates Clair API heading (#1060) (#1063)

Co-authored-by: Steven Smith <stevsmit@stevsmit-thinkpadt14gen4.remote.csb>
quay · Aug 9, 2024 · b6dc01e · b6dc01e
1 parent 45b0bf1
commit b6dc01e
Show file tree

Hide file tree

Showing 54 changed files with 517 additions and 14 deletions.
diff --git a/modules/adding-managing-labels-api.adoc b/modules/adding-managing-labels-api.adoc
@@ -77,7 +77,7 @@ $ curl -X POST \
 {"label": {"id": "346593fd-18c8-49db-854f-4cb1fb76ff9c", "key": "example-key", "value": "example-value", "source_type": "api", "media_type": "text/plain"}}
 ----
 
-. 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:
+. 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:
 +
 [source,terminal]
 ----

diff --git a/modules/api-logs-exportOrgLogs.adoc b/modules/api-logs-exportOrgLogs.adoc
@@ -61,3 +61,19 @@ _optional_|The e-mail address at which to e-mail a link to the exported logs|str
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+[source,terminal]
+----
+$ curl -X POST \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Content-Type: application/json" \
+  -H "Accept: application/json" \
+  -d '{
+        "starttime": "<MM/DD/YYYY>",
+        "endtime": "<MM/DD/YYYY>",
+        "callback_email": "org.logs@example.com"
+      }' \
+  "http://<quay-server.example.com>/api/v1/organization/{orgname}/exportlogs"
+----
diff --git a/modules/api-logs-exportRepoLogs.adoc b/modules/api-logs-exportRepoLogs.adoc
@@ -61,3 +61,19 @@ _optional_|The e-mail address at which to e-mail a link to the exported logs|str
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+[source,terminal]
+----
+$ curl -X POST \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Content-Type: application/json" \
+  -H "Accept: application/json" \
+  -d '{
+        "starttime": "2024-01-01",
+        "endtime": "2024-06-18",
+        "callback_url": "http://your-callback-url.example.com"
+      }' \
+  "http://<quay-server.example.com>/api/v1/repository/{repository}/exportlogs"
+----
diff --git a/modules/api-logs-exportUserLogs.adoc b/modules/api-logs-exportUserLogs.adoc
@@ -51,3 +51,19 @@ _optional_|The e-mail address at which to e-mail a link to the exported logs|str
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+[source,terminal]
+----
+$ curl -X POST \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Content-Type: application/json" \
+  -H "Accept: application/json" \
+  -d '{
+        "starttime": "<MM/DD/YYYY>",
+        "endtime": "<MM/DD/YYYY>",
+        "callback_email": "your.email@example.com"
+      }' \
+  "http://<quay-server.example.com>/api/v1/user/exportlogs"
+----
diff --git a/modules/api-logs-getAggregateOrgLogs.adoc b/modules/api-logs-getAggregateOrgLogs.adoc
@@ -48,3 +48,13 @@ _optional_|Earliest time for logs. Format: "%m/%d/%Y" in UTC.|string
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+[source,terminal]
+----
+$ curl -X GET \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Accept: application/json" \
+  "<quay-server.example.com>/api/v1/organization/{orgname}/aggregatelogs"
+----
diff --git a/modules/api-logs-getAggregateRepoLogs.adoc b/modules/api-logs-getAggregateRepoLogs.adoc
@@ -46,3 +46,13 @@ _optional_|Earliest time for logs. Format: "%m/%d/%Y" in UTC.|string
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+[source,terminal]
+----
+$ curl -X GET \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Accept: application/json" \
+  "<quay-server.example.com>/api/v1/repository/<repository_name>/<namespace>/aggregatelogs?starttime=2024-01-01&endtime=2024-06-18""
+----
diff --git a/modules/api-logs-getAggregateUserLogs.adoc b/modules/api-logs-getAggregateUserLogs.adoc
@@ -38,3 +38,13 @@ _optional_|Earliest time for logs. Format: "%m/%d/%Y" in UTC.|string
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+[source,terminal]
+----
+$ curl -X GET \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Accept: application/json" \
+  "<quay-server.example.com>/api/v1/user/aggregatelogs?performer=<username>&starttime=<MM/DD/YYYY>&endtime=<MM/DD/YYYY>"
+----
diff --git a/modules/api-logs-listOrgLogs.adoc b/modules/api-logs-listOrgLogs.adoc
@@ -50,3 +50,13 @@ _optional_|Earliest time for logs. Format: "%m/%d/%Y" in UTC.|string
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+[source,terminal]
+----
+$ curl -X GET \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Accept: application/json" \
+  "http://<quay-server.example.com>/api/v1/organization/{orgname}/logs"
+----
diff --git a/modules/api-logs-listRepoLogs.adoc b/modules/api-logs-listRepoLogs.adoc
@@ -48,3 +48,13 @@ _optional_|Earliest time for logs. Format: "%m/%d/%Y" in UTC.|string
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+[source,terminal]
+----
+$ curl -X GET \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Accept: application/json" \
+  "http://<quay-server.example.com>/api/v1/repository/{repository}/logs"
+----
diff --git a/modules/api-logs-listUserLogs.adoc b/modules/api-logs-listUserLogs.adoc
@@ -40,3 +40,10 @@ _optional_|Earliest time for logs. Format: "%m/%d/%Y" in UTC.|string
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+[source,terminal]
+----
+$ curl -X GET   -H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY"   -H "Accept: application/json"   "quay-server.example.com/api/v1/user/logs"
+----
diff --git a/modules/api-manifest-addManifestLabel.adoc b/modules/api-manifest-addManifestLabel.adoc
@@ -52,3 +52,18 @@ _required_|The media type for this label|
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+[source,terminal]
+----
+$ curl -X POST \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Content-Type: application/json" \
+  --data '{
+    "key": "<key>",
+    "value": "<value>",
+    "media_type": "<media_type>"
+  }' \
+  https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>/labels
+----
diff --git a/modules/api-manifest-deleteManifestLabel.adoc b/modules/api-manifest-deleteManifestLabel.adoc
@@ -37,3 +37,12 @@ _required_|The ID of the label|string
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+[source,terminal]
+----
+$ curl -X DELETE \
+  -H "Authorization: Bearer <bearer_token>" \
+  https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>/labels/<labelid>
+----
diff --git a/modules/api-manifest-getManifestLabel.adoc b/modules/api-manifest-getManifestLabel.adoc
@@ -37,3 +37,13 @@ _required_|The ID of the label|string
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+[source,terminal]
+----
+$ curl -X GET \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Accept: application/json" \
+  https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>/labels/<label_id>
+----
diff --git a/modules/api-manifest-getRepoManifest.adoc b/modules/api-manifest-getRepoManifest.adoc
@@ -35,3 +35,13 @@ _required_|The digest of the manifest|string
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+[source,terminal]
+----
+$ curl -X GET \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Accept: application/json" \
+  https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>
+----
diff --git a/modules/api-manifest-listManifestLabels.adoc b/modules/api-manifest-listManifestLabels.adoc
@@ -46,3 +46,13 @@ _optional_|If specified, only labels matching the given prefix will be returned|
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+[source,terminal]
+----
+$ curl -X GET \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Accept: application/json" \
+  https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>/labels
+----
diff --git a/modules/api-organization-deleteAdminedOrganization.adoc b/modules/api-organization-deleteAdminedOrganization.adoc
@@ -33,3 +33,13 @@ _required_|The name of the organization|string
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+
+[source,terminal]
+----
+$ curl -X GET \
+  -H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY" \
+  "<quay-server.example.com>/api/v1/organization/<organization_name>"
+----
diff --git a/modules/api-permission-changeUserPermissions.adoc b/modules/api-permission-changeUserPermissions.adoc
@@ -48,3 +48,15 @@ _required_|Role to use for the user|string
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+
+[source,terminal]
+----
+$ curl -X PUT \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Content-Type: application/json" \
+  -d '{"role": "admin"}' \
+  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>
+----
diff --git a/modules/api-permission-deleteUserPermissions.adoc b/modules/api-permission-deleteUserPermissions.adoc
@@ -35,3 +35,13 @@ _required_|The full path of the repository. e.g. namespace/name|string
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command 
+[source,terminal]
+----
+$ curl -X DELETE \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Accept: application/json" \
+  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>
+----
diff --git a/modules/api-permission-listRepoUserPermissions.adoc b/modules/api-permission-listRepoUserPermissions.adoc
@@ -33,3 +33,14 @@ _required_|The full path of the repository. e.g. namespace/name|string
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+
+[source,terminal]
+----
+$ curl -X GET \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Accept: application/json" \
+  https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository>/permissions/user/<username>/
+----
diff --git a/modules/api-prototype-createOrganizationPrototypePermission.adoc b/modules/api-prototype-createOrganizationPrototypePermission.adoc
@@ -50,3 +50,20 @@ _required_|Information about the user or team to which the rule grants access|ob
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+
+[source,terminal]
+----
+$ curl -X POST   -H "Authorization: Bearer <bearer_token>"   -H "Content-Type: application/json"   --data '{
+    "role": "<admin_read_or_write>",
+    "delegate": {
+      "name": "<username>",
+      "kind": "user"
+    },
+    "activating_user": {
+      "name": "<robot_name>"
+    }
+  }'   https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes
+----
diff --git a/modules/api-prototype-deleteOrganizationPrototypePermission.adoc b/modules/api-prototype-deleteOrganizationPrototypePermission.adoc
@@ -35,3 +35,13 @@ _required_|The name of the organization|string
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+[source,terminal]
+----
+curl -X DELETE \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Accept: application/json" \
+  https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes/<prototype_id>
+----
diff --git a/modules/api-prototype-getOrganizationPrototypePermissions.adoc b/modules/api-prototype-getOrganizationPrototypePermissions.adoc
@@ -33,3 +33,14 @@ _required_|The name of the organization|string
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+
+[source,terminal]
+----
+$ curl -X GET \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Accept: application/json" \
+  https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes
+----
diff --git a/modules/api-prototype-updateOrganizationPrototypePermission.adoc b/modules/api-prototype-updateOrganizationPrototypePermission.adoc
@@ -48,3 +48,16 @@ _optional_|Role that should be applied to the permission|string
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+[source,terminal]
+----
+$ curl -X PUT \
+  -H "Authorization: Bearer <bearer_token>" \
+  -H "Content-Type: application/json" \
+  --data '{
+    "role": "write"
+  }' \
+  https://<quay-server.example.com>/api/v1/organization/<organization_name>/prototypes/<prototypeid>
+----
diff --git a/modules/api-repository-deleteRepository.adoc b/modules/api-repository-deleteRepository.adoc
@@ -33,3 +33,11 @@ _required_|The full path of the repository. e.g. namespace/name|string
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+
+[source,terminal]
+----
+$ curl -X DELETE   -H "Authorization: Bearer <bearer_token>" "quay-server.example.com/api/v1/repository/<namespace>/<repository_name>"
+----
diff --git a/modules/api-repository-getRepo.adoc b/modules/api-repository-getRepo.adoc
@@ -46,3 +46,11 @@ _optional_|Whether to include action statistics|boolean
 |403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
 |404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
 |===
+
+[discrete]
+== Example command
+
+[source,terminal]
+----
+$ curl -X GET -H "Authorization: Bearer <bearer_token>" "quay-server.example.com/api/v1/repository/<namespace>/<repository_name>"
+----