Skip to content

Commit 67244f2

Browse files
stevsmitSteven Smith
andauthored
Fixes a few random errors in the API guide (quay#1194)
Co-authored-by: Steven Smith <[email protected]>
1 parent dd055e7 commit 67244f2

File tree

4 files changed

+6
-5
lines changed

4 files changed

+6
-5
lines changed

modules/api-global-messages.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Use the following procedure to create, obtain, or delete a global message.
1111
1212
.Procedure
1313

14-
. Create a message by using the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#createglobalmessage[`POST /api/v1/message] endpoint:
14+
. Create a message by using the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#createglobalmessage[`POST /api/v1/message`] endpoint:
1515
+
1616
[source,terminal]
1717
----
@@ -29,7 +29,7 @@ $ curl -X POST "https://quay-server.example.com/api/v1/messages" \
2929
+
3030
This command does not return output.
3131

32-
. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/{productname}/html-single/red_hat_quay_api_guide/index#getglobalmessages[`GET /api/v1/messages`] command to return the list of global messages:
32+
. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#getglobalmessages[`GET /api/v1/messages`] command to return the list of global messages:
3333
+
3434
[source,terminal]
3535
----
@@ -44,7 +44,7 @@ $ curl -X GET "https://<quay-server.example.com>/api/v1/messages" \
4444
{"messages": [{"uuid": "ecababd4-3451-4458-b5db-801684137444", "content": "Hi", "severity": "info", "media_type": "text/plain"}]}
4545
----
4646

47-
. Delete the global message by using the link:https://docs.redhat.com/en/documentation/red_hat_quay/{productname}/html-single/red_hat_quay_api_guide/index#deleteglobalmessage[`DELETE /api/v1/message/{uuid}`] endpoint:
47+
. Delete the global message by using the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#deleteglobalmessage[`DELETE /api/v1/message/{uuid}`] endpoint:
4848
+
4949
[source,terminal]
5050
----

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ With the API, {productname} administrators and users with access to the API can
1515

1616
. Create a Python script that executes an API command. The following example is used to prune images using the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#deletefulltag[`DELETE /api/v1/repository/{repository}/tag/{tag}`] API endpoint.
1717
+
18+
.example.py file
1819
[source,python]
1920
----
2021
import requests <1>

modules/regenerating-robot-account-token-api.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ $ curl -X POST \
2020
"<quay-server.example.com>/api/v1/organization/<orgname>/robots/<robot_shortname>/regenerate"
2121
----
2222
+
23-
. Example output
23+
.Example output
2424
+
2525
[source,terminal]
2626
----

modules/using-the-api.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,6 @@ $ curl -X POST \
8282
8383
.Verification
8484

85-
. On the {productname} UI, click your username in the navigation pane -> *Account Settings*. The name of your application appears under the *Docker CLI and other Application Tokens* heading. For example:
85+
* On the {productname} UI, click your username in the navigation pane -> *Account Settings*. The name of your application appears under the *Docker CLI and other Application Tokens* heading. For example:
8686
+
8787
image::application-token.png[Application token]

0 commit comments

Comments
 (0)