Updates a few api commands for technical accuracy (#1071)

Co-authored-by: Steven Smith <stevsmit@stevsmit-thinkpadt14gen4.remote.csb>
quay · Aug 14, 2024 · 12c03d7 · 12c03d7
1 parent a2da0b8
commit 12c03d7
Show file tree

Hide file tree

Showing 25 changed files with 43 additions and 43 deletions.
diff --git a/modules/api-logs-listUserLogs.adoc b/modules/api-logs-listUserLogs.adoc
@@ -45,5 +45,5 @@ _optional_|Earliest time for logs. Format: "%m/%d/%Y" in UTC.|string
 == Example command
 [source,terminal]
 ----
-$ curl -X GET   -H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY"   -H "Accept: application/json"   "quay-server.example.com/api/v1/user/logs"
+$ curl -X GET   -H "Authorization: Bearer <bearer_token>"   -H "Accept: application/json"   "<quay-server.example.com>/api/v1/user/logs"
 ----
diff --git a/modules/api-organization-deleteAdminedOrganization.adoc b/modules/api-organization-deleteAdminedOrganization.adoc
@@ -40,6 +40,6 @@ _required_|The name of the organization|string
 [source,terminal]
 ----
 $ curl -X GET \
-  -H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY" \
+  -H "Authorization: Bearer <bearer_token>" \
   "<quay-server.example.com>/api/v1/organization/<organization_name>"
 ----
diff --git a/modules/api-organization-getOrganization.adoc b/modules/api-organization-getOrganization.adoc
@@ -38,6 +38,6 @@ _required_|The name of the organization|string
 [source,terminal]
 ----
 $ curl -X GET \
-  -H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY" \
+  -H "Authorization: Bearer <bearer_token>" \
   "<quay-server.example.com>/api/v1/organization/<organization_name>"
 ----
diff --git a/modules/api-repository-deleteRepository.adoc b/modules/api-repository-deleteRepository.adoc
@@ -39,5 +39,5 @@ _required_|The full path of the repository. e.g. namespace/name|string
 
 [source,terminal]
 ----
-$ curl -X DELETE   -H "Authorization: Bearer <bearer_token>" "quay-server.example.com/api/v1/repository/<namespace>/<repository_name>"
+$ 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
@@ -52,5 +52,5 @@ _optional_|Whether to include action statistics|boolean
 
 [source,terminal]
 ----
-$ curl -X GET -H "Authorization: Bearer <bearer_token>" "quay-server.example.com/api/v1/repository/<namespace>/<repository_name>"
+$ curl -X GET -H "Authorization: Bearer <bearer_token>" "<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>"
 ----
diff --git a/modules/api-robot-deleteOrgRobot.adoc b/modules/api-robot-deleteOrgRobot.adoc
@@ -42,6 +42,6 @@ _required_|The name of the organization|string
 [source,terminal]
 ----
 curl -X DELETE \
-  -H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY" \
-  "quay-server.example.com/api/v1/organization/<organization_name>/robots/<robot_shortname>"
+  -H "Authorization: Bearer <bearer_token>" \
+  "<quay-server.example.com>/api/v1/organization/<organization_name>/robots/<robot_shortname>"
 ----
diff --git a/modules/api-robot-deleteUserRobot.adoc b/modules/api-robot-deleteUserRobot.adoc
@@ -39,6 +39,6 @@ _required_|The short name for the robot, without any user or organization prefix
 [source,terminal]
 ----
 $ curl -X DELETE \
-  -H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY" \
-  "quay-server.example.com/api/v1/user/robots/<robot_shortname>"
+  -H "Authorization: Bearer <bearer_token>" \
+  "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>"
 ----
diff --git a/modules/api-robot-getUserRobot.adoc b/modules/api-robot-getUserRobot.adoc
@@ -40,6 +40,6 @@ _required_|The short name for the robot, without any user or organization prefix
 [source,terminal]
 ----
 $ curl -X GET \
-  -H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY" \
-  "quay-server.example.com/api/v1/user/robots/<robot_shortname>"
+  -H "Authorization: Bearer <bearer_token>" \
+  "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>"
 ----
diff --git a/modules/api-robot-regenerateOrgRobotToken.adoc b/modules/api-robot-regenerateOrgRobotToken.adoc
@@ -43,5 +43,5 @@ _required_|The name of the organization|string
 ----
 $ curl -X POST \
   -H "Authorization: Bearer <bearer_token>" \
-  "quay-server.example.com/api/v1/organization/<orgname>/robots/<robot_shortname>/regenerate"
+  "<quay-server.example.com>/api/v1/organization/<orgname>/robots/<robot_shortname>/regenerate"
 ---- 
diff --git a/modules/api-robot-regenerateUserRobotToken.adoc b/modules/api-robot-regenerateUserRobotToken.adoc
@@ -40,5 +40,5 @@ _required_|The short name for the robot, without any user or organization prefix
 ----
 $ curl -X POST \
   -H "Authorization: Bearer <bearer_token>" \
-  "quay-server.example.com/api/v1/user/robots/<robot_shortname>/regenerate"
+  "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>/regenerate"
 ----
diff --git a/modules/api-team-deleteOrganizationTeam.adoc b/modules/api-team-deleteOrganizationTeam.adoc
@@ -42,5 +42,5 @@ _required_|The name of the organization|string
 ----
 $ curl -X DELETE \
   -H "Authorization: Bearer <your_access_token>" \
-  "quay-server.example.com/api/v1/organization/<organization_name>/team/<team_name>"
+  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>"
 ----
diff --git a/modules/api-team-deleteOrganizationTeamMember.adoc b/modules/api-team-deleteOrganizationTeamMember.adoc
@@ -47,5 +47,5 @@ _required_|The name of the organization|string
 ----
 $ curl -X DELETE \
   -H "Authorization: Bearer <your_access_token>" \
-  "quay-server.example.com/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"
+  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"
 ----
diff --git a/modules/api-team-deleteTeamMemberEmailInvite.adoc b/modules/api-team-deleteTeamMemberEmailInvite.adoc
@@ -45,5 +45,5 @@ _required_||string
 ----
 $ curl -X DELETE \
   -H "Authorization: Bearer <your_access_token>" \
-  "quay-server.example.com/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"
+  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"
 ----
diff --git a/modules/api-team-getOrganizationTeamMembers.adoc b/modules/api-team-getOrganizationTeamMembers.adoc
@@ -54,5 +54,5 @@ _optional_|Whether to include pending members|boolean
 ----
 $ curl -X GET \
   -H "Authorization: Bearer <your_access_token>" \
-  "quay-server.example.com/api/v1/organization/<organization_name>/team/<team_name>/members"
+  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members"
 ----
diff --git a/modules/api-team-inviteTeamMemberEmail.adoc b/modules/api-team-inviteTeamMemberEmail.adoc
@@ -45,5 +45,5 @@ _required_||string
 ----
 $ curl -X PUT \
   -H "Authorization: Bearer <your_access_token>" \
-  "quay-server.example.com/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"
+  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"
 ----
diff --git a/modules/api-team-updateOrganizationTeamMember.adoc b/modules/api-team-updateOrganizationTeamMember.adoc
@@ -45,5 +45,5 @@ _required_|The name of the organization|string
 ----
 $ curl -X PUT \
   -H "Authorization: Bearer <your_access_token>" \
-  "quay-server.example.com/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"
+  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"
 ----
diff --git a/modules/deleting-an-image-repository-via-the-api.adoc b/modules/deleting-an-image-repository-via-the-api.adoc
@@ -20,14 +20,14 @@ Use the following procedure to delete a repository using the {productname} API.
 +
 [source,terminal]
 ----
-$ curl -X DELETE   -H "Authorization: Bearer <bearer_token>" "quay-server.example.com/api/v1/repository/<namespace>/<repository_name>"
+$ curl -X DELETE   -H "Authorization: Bearer <bearer_token>" "<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>"
 ----
 
 . The CLI does not return information when deleting a repository from the CLI. To confirm deletion, you can check the {productname} UI, or you can enter the following link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#getrepo[`GET /api/v1/repository/{repository}`] command to see if details are returned for the deleted repository:
 +
 [source,terminal]
 ----
-$ curl -X GET -H "Authorization: Bearer <bearer_token>" "quay-server.example.com/api/v1/repository/<namespace>/<repository_name>"
+$ curl -X GET -H "Authorization: Bearer <bearer_token>" "<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>"
 ----
 +
 Example output

diff --git a/modules/deleting-robot-account-api.adoc b/modules/deleting-robot-account-api.adoc
@@ -21,8 +21,8 @@ Use the following procedure to delete a robot account using the {productname} AP
 [source,terminal]
 ----
 curl -X DELETE \
-  -H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY" \
-  "quay-server.example.com/api/v1/organization/<organization_name>/robots/<robot_shortname>"
+  -H "Authorization: Bearer <bearer_token>" \
+  "<quay-server.example.com>/api/v1/organization/<organization_name>/robots/<robot_shortname>"
 ----
 
 . The CLI does not return information when deleting a robot account with the API. To confirm deletion, you can check the {productname} UI, or you can enter the following link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#getorgrobots[`GET /api/v1/organization/{orgname}/robots`] command to see if details are returned for the robot account:
@@ -39,22 +39,22 @@ Example output
 {"robots": []}
 ----
 
-* Enter the following command to delete a robot account for the current user with the link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#deleteuserrobot[`DELETE /api/v1/user/robots/{robot_shortname}`] endpoint:
+. Enter the following command to delete a robot account for the current user with the link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#deleteuserrobot[`DELETE /api/v1/user/robots/{robot_shortname}`] endpoint:
 +
 [source,terminal]
 ----
 $ curl -X DELETE \
-  -H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY" \
-  "quay-server.example.com/api/v1/user/robots/<robot_shortname>"
+  -H "Authorization: Bearer <bearer_token>" \
+  "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>"
 ----
 
 . The CLI does not return information when deleting a robot account for the current user with the API. To confirm deletion, you can check the {productname} UI, or you can enter the following link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#getuserrobot[`GET /api/v1/user/robots/{robot_shortname}`] command to see if details are returned for the robot account:
 +
 [source,terminal]
 ----
 $ curl -X GET \
-  -H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY" \
-  "quay-server.example.com/api/v1/user/robots/<robot_shortname>"
+  -H "Authorization: Bearer <bearer_token>" \
+  "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>"
 ----
 +
 Example output

diff --git a/modules/deleting-team-within-organization-api.adoc b/modules/deleting-team-within-organization-api.adoc
@@ -22,7 +22,7 @@ Use the following procedure to delete a team within an organization by using the
 ----
 $ curl -X DELETE \
   -H "Authorization: Bearer <your_access_token>" \
-  "quay-server.example.com/api/v1/organization/<organization_name>/team/<team_name>"
+  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>"
 ----
 +
 This command does not return output in the CLI. 
diff --git a/modules/managing-team-members-api.adoc b/modules/managing-team-members-api.adoc
@@ -22,7 +22,7 @@ Use the following procedures to add a member to a team (by direct invite or by e
 ----
 $ curl -X PUT \
   -H "Authorization: Bearer <your_access_token>" \
-  "quay-server.example.com/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"
+  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"
 ----
 +
 .Example output
@@ -38,7 +38,7 @@ $ curl -X PUT \
 ----
 $ curl -X DELETE \
   -H "Authorization: Bearer <your_access_token>" \
-  "quay-server.example.com/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"
+  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members/<member_name>"
 ----
 +
 This command does not an output in the CLI. To ensure that a member has been deleted, you can enter the link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#getorganizationteammembers[`GET /api/v1/organization/{orgname}/team/{teamname}/members`] command and ensure that the member is not returned in the output.
@@ -47,7 +47,7 @@ This command does not an output in the CLI. To ensure that a member has been del
 ----
 $ curl -X GET \
   -H "Authorization: Bearer <your_access_token>" \
-  "quay-server.example.com/api/v1/organization/<organization_name>/team/<team_name>/members"
+  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/members"
 ----
 +
 .Example output
@@ -63,7 +63,7 @@ $ curl -X GET \
 ----
 $ curl -X PUT \
   -H "Authorization: Bearer <your_access_token>" \
-  "quay-server.example.com/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"
+  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"
 ----
 
 * You can enter the link:https://docs.redhat.com/en/documentation/red_hat_quay/3/html-single/red_hat_quay_api_guide/index#deleteteammemberemailinvite[`DELETE /api/v1/organization/{orgname}/team/{teamname}/invite/{email}`] command to delete the invite of an email address to join a team. For example: 
@@ -72,5 +72,5 @@ $ curl -X PUT \
 ----
 $ curl -X DELETE \
   -H "Authorization: Bearer <your_access_token>" \
-  "quay-server.example.com/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"
+  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/invite/<email>"
 ----
diff --git a/modules/org-delete-api.adoc b/modules/org-delete-api.adoc
@@ -20,7 +20,7 @@ Use the following procedure to delete an organization using the {productname} AP
 [source,terminal]
 ----
 $ curl -X DELETE \
-  -H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY" \
+  -H "Authorization: Bearer <bearer_token>" \
   "https://<quay-server.example.com>/api/v1/organization/<organization_name>"
 ----
 
@@ -29,7 +29,7 @@ $ curl -X DELETE \
 [source,terminal]
 ----
 $ curl -X GET \
-  -H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY" \
+  -H "Authorization: Bearer <bearer_token>" \
   "<quay-server.example.com>/api/v1/organization/<organization_name>"
 ----
 +

diff --git a/modules/regenerating-robot-account-token-api.adoc b/modules/regenerating-robot-account-token-api.adoc
@@ -17,7 +17,7 @@ Use the following procedure to regenerate a robot account token using the {produ
 ----
 $ curl -X POST \
   -H "Authorization: Bearer <bearer_token>" \
-  "quay-server.example.com/api/v1/organization/<orgname>/robots/<robot_shortname>/regenerate"
+  "<quay-server.example.com>/api/v1/organization/<orgname>/robots/<robot_shortname>/regenerate"
 ----
 +
 . Example output
@@ -33,7 +33,7 @@ $ curl -X POST \
 ----
 $ curl -X POST \
   -H "Authorization: Bearer <bearer_token>" \
-  "quay-server.example.com/api/v1/user/robots/<robot_shortname>/regenerate"
+  "<quay-server.example.com>/api/v1/user/robots/<robot_shortname>/regenerate"
 ----
 +
 Example output

diff --git a/modules/setting-role-of-team-within-organization-api.adoc b/modules/setting-role-of-team-within-organization-api.adoc
@@ -23,7 +23,7 @@ Use the following procedure to view and set the role a team within an organizati
 ----
 $ curl -X GET \
   -H "Authorization: Bearer <your_access_token>" \
-  "quay-server.example.com/api/v1/organization/<organization_name>/team/<team_name>/permissions"
+  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>/permissions"
 ----
 +
 .Example output
@@ -43,7 +43,7 @@ $ curl -X PUT \
   -d '{
     "role": "<role>"
   }' \
-  "quay-server.example.com/api/v1/organization/<organization_name>/team/<team_name>"
+  "<quay-server.example.com>/api/v1/organization/<organization_name>/team/<team_name>"
 ----
 +
 .Example output

diff --git a/modules/viewing-tag-history-v2-api.adoc b/modules/viewing-tag-history-v2-api.adoc
@@ -40,7 +40,7 @@ $ curl -X GET \
 +
 [source,terminal]
 ----
-$ curl -X GET   -H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY"   -H "Accept: application/json"   "quay-server.example.com/api/v1/repository/quayadmin/busybox/tag/?onlyActiveTags=true&page=1&limit=20&specificTag=test-two"
+$ curl -X GET   -H "Authorization: Bearer <bearer_token>"   -H "Accept: application/json"   "<quay-server.example.com>/api/v1/repository/quayadmin/busybox/tag/?onlyActiveTags=true&page=1&limit=20&specificTag=test-two"
 ----
 +
 .Example output

diff --git a/modules/viewing-usage-logs-api.adoc b/modules/viewing-usage-logs-api.adoc
@@ -75,14 +75,14 @@ Detailed logs can be viewed by Organization, repository, a specific user, or the
 +
 [source,terminal]
 ----
-$ curl -X GET   -H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY"   -H "Accept: application/json"   "quay-server.example.com/api/v1/user/logs"
+$ curl -X GET   -H "Authorization: Bearer <bearer_token>"   -H "Accept: application/json"   "<quay-server.example.com>/api/v1/user/logs"
 ----
 +
 You can also pass in the `performer` and `startime/endtime` queries to obtain logs for a specific user between a specific time period. For example:
 +
 [source,terminal]
 ----
-$ curl -X GET   -H "Authorization: Bearer lfV4lVf9qRsyoFnrgEno1umIOrsdp8lPyMnfUDYY"   -H "Accept: application/json"   "http://quay-server.example.com/api/v1/user/logs?performer=quayuser&starttime=01/01/2024&endtime=06/18/2024"
+$ curl -X GET   -H "Authorization: Bearer <bearer_token>"   -H "Accept: application/json"   "http://quay-server.example.com/api/v1/user/logs?performer=quayuser&starttime=01/01/2024&endtime=06/18/2024"
 ----
 +
 .Example output