Skip to content

Commit dd055e7

Browse files
stevsmitSteven Smith
andauthored
Slight using reorg (quay#1193)
Co-authored-by: Steven Smith <[email protected]>
1 parent f143a4d commit dd055e7

File tree

3 files changed

+18
-13
lines changed

3 files changed

+18
-13
lines changed

api/master.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
include::modules/attributes.adoc[]
33
[id="api"]
44
= {productname} API guide
5+
:context: use-api
56

67
The {productname} application programming interface (API) provides a comprehensive, RESTful interface for managing and automating tasks within {productname}. Designed around the link:https://oauth.net/2/[_OAuth 2.0 protocol_], this API enables secure, fine-grained access to {productname} resources, and allows administrators and users to perform such actions as creating repositories, managing images, setting permissions, and more.
78

modules/enabling-using-the-api.adoc

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,17 @@
44

55
By leveraging the {productname} API, you can streamline container registry management, automate tasks, and integrate {productname}'s functionalities into your existing workflow. This can improve efficiency, offer enhanced flexibility (by way of repository management, user management, user permissions, image management, and so on), increase the stability of your organization, repository, or overall deployment, and more.
66
7-
The following sections explain how to enable and use the {productname} API.
7+
ifeval::["{context}" == "use-quay"]
8+
Detailed instructions for how to use the {productname} API can be found in the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index[{productname} API guide]. In that guide, the following topics are covered:
9+
10+
* {productname} token types, including OAuth 2 access tokens, robot account tokens, and OCI referrers tokens, and how to generate these tokens.
11+
* Enabling the {productname} API by configuring your `config.yaml` file.
12+
* How to use the {productname} API by passing in your OAuth 2 account token into the desired endpoint.
13+
* API examples, including one generic example of how an administrator might automate certain tasks.
14+
15+
See the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index[{productname} API guide] before attempting to use the API endpoints offered in this chapter.
16+
endif::[]
17+
18+
ifeval::["{context}" == "use-api"]
19+
The following sections explain how to enable and use the {productname} API.
20+
endif::[]

use_quay/master.adoc

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ The following API endpoints are linked to their associated entry in the link:htt
1717
//intro and tenancy
1818
include::modules/user-org-intro.adoc[leveloffset=+1]
1919
include::modules/tenancy-model.adoc[leveloffset=+2]
20+
//Red Hat Quay API
21+
include::modules/enabling-using-the-api.adoc[leveloffset=+1]
22+
2023
//creating and deleting users
2124
include::modules/user-create.adoc[leveloffset=+1]
2225
include::modules/creating-user-account-quay-ui.adoc[leveloffset=+2]
@@ -147,18 +150,6 @@ include::modules/build-enhancements.adoc[leveloffset=+1]
147150
//include::modules/build-limitations.adoc[leveloffset=+2]
148151
//include::modules/builders-virtual-environment.adoc[leveloffset=+2]
149152
150-
//api
151-
include::modules/proc_use-api.adoc[leveloffset=+1]
152-
153-
154-
155-
156-
157-
158-
159-
160-
161-
162153
//oci
163154
include::modules/oci-intro.adoc[leveloffset=+1]
164155
include::modules/helm-oci-prereqs.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)