Skip to content

Commit 4954b97

Browse files
stevsmitSteven Smith
stevsmit
and
Steven Smith
authored
Adds footer config fields to config guide (#1247) (#1248)
Co-authored-by: Steven Smith <[email protected]>
1 parent 842aba7 commit 4954b97

File tree

4 files changed

+293
-3
lines changed

4 files changed

+293
-3
lines changed

‎api/master.adoc

+2-3
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The following guide describes the {productname} API in more detail, and provides
2323
* Using the {productname} API
2424
* {productname} API configuration examples
2525
26-
//This guide is accompanied with a second guide, . . ., that provides information about all `api/v1` endpoints and how to access those endpoints with example commands.
26+
This guide is accompanied with a second guide, link:https://docs.redhat.com/en/documentation/red_hat_quay/3.13/html/red_hat_quay_api_reference/index[{productname} API reference], that provides information about all `api/v1` endpoints and how to access those endpoints with example commands.
2727
2828
//overview
2929
include::modules/token-overview.adoc[leveloffset=+1]
@@ -136,7 +136,7 @@ include::modules/managing-user-options-api.adoc[leveloffset=+2]
136136
137137
//include::modules/proc_use-api.adoc[leveloffset=+1]
138138
139-
139+
////
140140
== {productname} Application Programming Interface (API)
141141
[id="ref-api-quay"]
142142
@@ -388,7 +388,6 @@ include::modules/api-user-getUserInformation.adoc[leveloffset=+3]
388388
389389
include::modules/api-definitions.adoc[leveloffset=+2]
390390
391-
////
392391
// do not remove
393392
[id="api-config-examples"]
394393
== API configuration examples

‎api_reference/docinfo.xml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<productname>{productname}</productname>
2+
<productnumber>{producty}</productnumber>
3+
<subtitle>{productname} API reference</subtitle>
4+
<abstract>
5+
<para>{productname} API reference</para>
6+
</abstract>
7+
<authorgroup>
8+
<orgname>Red Hat OpenShift Documentation Team</orgname>
9+
</authorgroup>
10+
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

‎api_reference/master.adoc

+280
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,280 @@
1+
:_content-type: ASSEMBLY
2+
include::modules/attributes.adoc[]
3+
[id="api-reference"]
4+
= {productname} API reference
5+
:context: use-api
6+
7+
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.
8+
9+
{productname} follows Semantic Versioning (SemVer) principles, ensuring predictable API stability across releases, such as:
10+
11+
* *Major releases*: Introduce new capabilities. Might include breaking changes to API compatibility. For example, the API of {productname} _2.0_ differs from {productname} _3.0_.
12+
13+
* *Minor releases*: Add new functionality in a backward-compatible manner. For example, a _3.y_ release adds functionality to the version _3._ release.
14+
15+
* *Patch releases*: Deliver bug fixes and improvements while preserving backward compatibility with minor releases, such as _3.y.z_.
16+
17+
The following guide describes the {productname} API in more detail, and provides details on the following topics:
18+
19+
* API endpoint structure, including supported HTTP methods
20+
* Request and response schemas for each endpoint
21+
* Required and optional parameters
22+
* Authentication and authorization requirements
23+
* Common error codes and troubleshooting information
24+
25+
For a more guided approach, including token overview, management strategies, understanding API endpoints, and more, refer to the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html/red_hat_quay_api_guide/index[{productname} API guide].
26+
27+
include::modules/api-authorization.adoc[leveloffset=+1]
28+
29+
//example procedures provided
30+
include::modules/api-appspecifictokens.adoc[leveloffset=+1]
31+
include::modules/api-appspecifictokens-createAppToken.adoc[leveloffset=+2]
32+
include::modules/api-appspecifictokens-listAppTokens.adoc[leveloffset=+2]
33+
include::modules/api-appspecifictokens-getAppToken.adoc[leveloffset=+2]
34+
include::modules/api-appspecifictokens-revokeAppToken.adoc[leveloffset=+2]
35+
36+
include::modules/api-build.adoc[leveloffset=+1]
37+
include::modules/api-build-getRepoBuildStatus.adoc[leveloffset=+2]
38+
include::modules/api-build-getRepoBuildLogs.adoc[leveloffset=+2]
39+
include::modules/api-build-getRepoBuild.adoc[leveloffset=+2]
40+
include::modules/api-build-cancelRepoBuild.adoc[leveloffset=+2]
41+
include::modules/api-build-requestRepoBuild.adoc[leveloffset=+2]
42+
include::modules/api-build-getRepoBuilds.adoc[leveloffset=+2]
43+
44+
//example procedures provided
45+
include::modules/api-discovery.adoc[leveloffset=+1]
46+
include::modules/api-discovery-discovery.adoc[leveloffset=+2]
47+
48+
//example procedures provided
49+
include::modules/api-error.adoc[leveloffset=+1]
50+
include::modules/api-error-getErrorDescription.adoc[leveloffset=+2]
51+
52+
//example procedures provided
53+
include::modules/api-globalmessages.adoc[leveloffset=+1]
54+
include::modules/api-globalmessages-createGlobalMessage.adoc[leveloffset=+2]
55+
include::modules/api-globalmessages-getGlobalMessages.adoc[leveloffset=+2]
56+
include::modules/api-globalmessages-deleteGlobalMessage.adoc[leveloffset=+2]
57+
58+
//example procedures provided
59+
include::modules/api-logs.adoc[leveloffset=+1]
60+
include::modules/api-logs-getAggregateUserLogs.adoc[leveloffset=+2]
61+
include::modules/api-logs-exportUserLogs.adoc[leveloffset=+2]
62+
include::modules/api-logs-listUserLogs.adoc[leveloffset=+2]
63+
include::modules/api-logs-getAggregateOrgLogs.adoc[leveloffset=+2]
64+
include::modules/api-logs-exportOrgLogs.adoc[leveloffset=+2]
65+
include::modules/api-logs-listOrgLogs.adoc[leveloffset=+2]
66+
include::modules/api-logs-getAggregateRepoLogs.adoc[leveloffset=+2]
67+
include::modules/api-logs-exportRepoLogs.adoc[leveloffset=+2]
68+
include::modules/api-logs-listRepoLogs.adoc[leveloffset=+2]
69+
70+
//example procedures provided
71+
include::modules/api-manifest.adoc[leveloffset=+1]
72+
include::modules/api-manifest-getManifestLabel.adoc[leveloffset=+2]
73+
include::modules/api-manifest-deleteManifestLabel.adoc[leveloffset=+2]
74+
include::modules/api-manifest-addManifestLabel.adoc[leveloffset=+2]
75+
include::modules/api-manifest-listManifestLabels.adoc[leveloffset=+2]
76+
include::modules/api-manifest-getRepoManifest.adoc[leveloffset=+2]
77+
78+
//example procedures provided
79+
include::modules/api-mirror.adoc[leveloffset=+1]
80+
include::modules/api-mirror-syncCancel.adoc[leveloffset=+2]
81+
include::modules/api-mirror-syncNow.adoc[leveloffset=+2]
82+
include::modules/api-mirror-getRepoMirrorConfig.adoc[leveloffset=+2]
83+
include::modules/api-mirror-changeRepoMirrorConfig.adoc[leveloffset=+2]
84+
include::modules/api-mirror-createRepoMirrorConfig.adoc[leveloffset=+2]
85+
86+
//commands provided
87+
include::modules/api-namespacequota.adoc[leveloffset=+1]
88+
include::modules/api-namespacequota-listUserQuota.adoc[leveloffset=+2]
89+
include::modules/api-namespacequota-getOrganizationQuotaLimit.adoc[leveloffset=+2]
90+
include::modules/api-namespacequota-changeOrganizationQuotaLimit.adoc[leveloffset=+2]
91+
include::modules/api-namespacequota-deleteOrganizationQuotaLimit.adoc[leveloffset=+2]
92+
include::modules/api-namespacequota-createOrganizationQuotaLimit.adoc[leveloffset=+2]
93+
include::modules/api-namespacequota-listOrganizationQuotaLimit.adoc[leveloffset=+2]
94+
include::modules/api-namespacequota-getUserQuotaLimit.adoc[leveloffset=+2]
95+
include::modules/api-namespacequota-listUserQuotaLimit.adoc[leveloffset=+2]
96+
include::modules/api-namespacequota-getOrganizationQuota.adoc[leveloffset=+2]
97+
include::modules/api-namespacequota-changeOrganizationQuota.adoc[leveloffset=+2]
98+
include::modules/api-namespacequota-deleteOrganizationQuota.adoc[leveloffset=+2]
99+
include::modules/api-namespacequota-createOrganizationQuota.adoc[leveloffset=+2]
100+
include::modules/api-namespacequota-listOrganizationQuota.adoc[leveloffset=+2]
101+
include::modules/api-namespacequota-getUserQuota.adoc[leveloffset=+2]
102+
103+
//done
104+
include::modules/api-organization.adoc[leveloffset=+1]
105+
include::modules/api-organization-createOrganization.adoc[leveloffset=+2]
106+
include::modules/api-organization-validateProxyCacheConfig.adoc[leveloffset=+2]
107+
include::modules/api-organization-getOrganizationCollaborators.adoc[leveloffset=+2]
108+
include::modules/api-organization-getOrganizationApplication.adoc[leveloffset=+2]
109+
include::modules/api-organization-updateOrganizationApplication.adoc[leveloffset=+2]
110+
include::modules/api-organization-deleteOrganizationApplication.adoc[leveloffset=+2]
111+
include::modules/api-organization-createOrganizationApplication.adoc[leveloffset=+2]
112+
include::modules/api-organization-getOrganizationApplications.adoc[leveloffset=+2]
113+
include::modules/api-organization-getProxyCacheConfig.adoc[leveloffset=+2]
114+
include::modules/api-organization-deleteProxyCacheConfig.adoc[leveloffset=+2]
115+
include::modules/api-organization-createProxyCacheConfig.adoc[leveloffset=+2]
116+
include::modules/api-organization-getOrganizationMember.adoc[leveloffset=+2]
117+
include::modules/api-organization-removeOrganizationMember.adoc[leveloffset=+2]
118+
include::modules/api-organization-getOrganizationMembers.adoc[leveloffset=+2]
119+
include::modules/api-organization-getOrganization.adoc[leveloffset=+2]
120+
include::modules/api-organization-changeOrganizationDetails.adoc[leveloffset=+2]
121+
include::modules/api-organization-deleteAdminedOrganization.adoc[leveloffset=+2]
122+
include::modules/api-organization-getApplicationInformation.adoc[leveloffset=+2]
123+
//done
124+
include::modules/api-permission.adoc[leveloffset=+1]
125+
include::modules/api-permission-getUserTransitivePermission.adoc[leveloffset=+2]
126+
include::modules/api-permission-getUserPermissions.adoc[leveloffset=+2]
127+
include::modules/api-permission-changeUserPermissions.adoc[leveloffset=+2]
128+
include::modules/api-permission-deleteUserPermissions.adoc[leveloffset=+2]
129+
include::modules/api-permission-getTeamPermissions.adoc[leveloffset=+2]
130+
include::modules/api-permission-changeTeamPermissions.adoc[leveloffset=+2]
131+
include::modules/api-permission-deleteTeamPermissions.adoc[leveloffset=+2]
132+
include::modules/api-permission-listRepoTeamPermissions.adoc[leveloffset=+2]
133+
include::modules/api-permission-listRepoUserPermissions.adoc[leveloffset=+2]
134+
//done but might need example procs
135+
include::modules/api-policy.adoc[leveloffset=+1]
136+
include::modules/api-policy-createOrganizationAutoPrunePolicy.adoc[leveloffset=+2]
137+
include::modules/api-policy-listOrganizationAutoPrunePolicies.adoc[leveloffset=+2]
138+
include::modules/api-policy-getOrganizationAutoPrunePolicy.adoc[leveloffset=+2]
139+
include::modules/api-policy-deleteOrganizationAutoPrunePolicy.adoc[leveloffset=+2]
140+
include::modules/api-policy-updateOrganizationAutoPrunePolicy.adoc[leveloffset=+2]
141+
include::modules/api-policy-createRepositoryAutoPrunePolicy.adoc[leveloffset=+2]
142+
include::modules/api-policy-listRepositoryAutoPrunePolicies.adoc[leveloffset=+2]
143+
include::modules/api-policy-getRepositoryAutoPrunePolicy.adoc[leveloffset=+2]
144+
include::modules/api-policy-deleteRepositoryAutoPrunePolicy.adoc[leveloffset=+2]
145+
include::modules/api-policy-updateRepositoryAutoPrunePolicy.adoc[leveloffset=+2]
146+
include::modules/api-policy-createUserAutoPrunePolicy.adoc[leveloffset=+2]
147+
include::modules/api-policy-listUserAutoPrunePolicies.adoc[leveloffset=+2]
148+
include::modules/api-policy-getUserAutoPrunePolicy.adoc[leveloffset=+2]
149+
include::modules/api-policy-deleteUserAutoPrunePolicy.adoc[leveloffset=+2]
150+
include::modules/api-policy-updateUserAutoPrunePolicy.adoc[leveloffset=+2]
151+
152+
//done
153+
include::modules/api-prototype.adoc[leveloffset=+1]
154+
include::modules/api-prototype-updateOrganizationPrototypePermission.adoc[leveloffset=+2]
155+
include::modules/api-prototype-deleteOrganizationPrototypePermission.adoc[leveloffset=+2]
156+
include::modules/api-prototype-createOrganizationPrototypePermission.adoc[leveloffset=+2]
157+
include::modules/api-prototype-getOrganizationPrototypePermissions.adoc[leveloffset=+2]
158+
//won't do
159+
include::modules/api-referrers.adoc[leveloffset=+1]
160+
include::modules/api-referrers-getReferrers.adoc[leveloffset=+2]
161+
162+
//done
163+
include::modules/api-repository.adoc[leveloffset=+1]
164+
//do not edit
165+
include::modules/api-repository-createRepo.adoc[leveloffset=+2]
166+
include::modules/api-repository-listRepos.adoc[leveloffset=+2]
167+
include::modules/api-repository-changeRepoVisibility.adoc[leveloffset=+2]
168+
include::modules/api-repository-changeRepoState.adoc[leveloffset=+2]
169+
include::modules/api-repository-getRepo.adoc[leveloffset=+2]
170+
include::modules/api-repository-updateRepo.adoc[leveloffset=+2]
171+
include::modules/api-repository-deleteRepository.adoc[leveloffset=+2]
172+
173+
//done
174+
include::modules/api-repositorynotification.adoc[leveloffset=+1]
175+
include::modules/api-repositorynotification-testRepoNotification.adoc[leveloffset=+2]
176+
include::modules/api-repositorynotification-getRepoNotification.adoc[leveloffset=+2]
177+
include::modules/api-repositorynotification-deleteRepoNotification.adoc[leveloffset=+2]
178+
include::modules/api-repositorynotification-resetRepositoryNotificationFailures.adoc[leveloffset=+2]
179+
include::modules/api-repositorynotification-createRepoNotification.adoc[leveloffset=+2]
180+
include::modules/api-repositorynotification-listRepoNotifications.adoc[leveloffset=+2]
181+
//done
182+
include::modules/api-robot.adoc[leveloffset=+1]
183+
include::modules/api-robot-getUserRobots.adoc[leveloffset=+2]
184+
include::modules/api-robot-getOrgRobotPermissions.adoc[leveloffset=+2]
185+
include::modules/api-robot-regenerateOrgRobotToken.adoc[leveloffset=+2]
186+
include::modules/api-robot-getUserRobotPermissions.adoc[leveloffset=+2]
187+
include::modules/api-robot-regenerateUserRobotToken.adoc[leveloffset=+2]
188+
include::modules/api-robot-getOrgRobot.adoc[leveloffset=+2]
189+
include::modules/api-robot-createOrgRobot.adoc[leveloffset=+2]
190+
include::modules/api-robot-deleteOrgRobot.adoc[leveloffset=+2]
191+
include::modules/api-robot-getOrgRobots.adoc[leveloffset=+2]
192+
include::modules/api-robot-getUserRobot.adoc[leveloffset=+2]
193+
include::modules/api-robot-createUserRobot.adoc[leveloffset=+2]
194+
include::modules/api-robot-deleteUserRobot.adoc[leveloffset=+2]
195+
include::modules/api-robot-getOrgRobotFederation.adoc[leveloffset=+2]
196+
include::modules/api-robot-createOrgRobotFederation.adoc[leveloffset=+2]
197+
//include::modules/api-robot-deleteOrgRobotFederation.adoc[leveloffset=+2]
198+
199+
//done
200+
include::modules/api-search.adoc[leveloffset=+1]
201+
include::modules/api-search-conductRepoSearch.adoc[leveloffset=+2]
202+
include::modules/api-search-conductSearch.adoc[leveloffset=+2]
203+
include::modules/api-search-getMatchingEntities.adoc[leveloffset=+2]
204+
205+
//done
206+
include::modules/api-secscan.adoc[leveloffset=+1]
207+
include::modules/api-secscan-getRepoManifestSecurity.adoc[leveloffset=+2]
208+
//done
209+
include::modules/api-superuser.adoc[leveloffset=+1]
210+
include::modules/api-superuser-createInstallUser.adoc[leveloffset=+2]
211+
include::modules/api-superuser-deleteInstallUser.adoc[leveloffset=+2]
212+
include::modules/api-superuser-listAllUsers.adoc[leveloffset=+2]
213+
include::modules/api-superuser-listAllLogs.adoc[leveloffset=+2]
214+
include::modules/api-superuser-listAllOrganizations.adoc[leveloffset=+2]
215+
include::modules/api-superuser-createServiceKey.adoc[leveloffset=+2]
216+
include::modules/api-superuser-listServiceKeys.adoc[leveloffset=+2]
217+
include::modules/api-superuser-changeUserQuotaSuperUser.adoc[leveloffset=+2]
218+
include::modules/api-superuser-deleteUserQuotaSuperUser.adoc[leveloffset=+2]
219+
include::modules/api-superuser-createUserQuotaSuperUser.adoc[leveloffset=+2]
220+
include::modules/api-superuser-listUserQuotaSuperUser.adoc[leveloffset=+2]
221+
include::modules/api-superuser-changeOrganizationQuotaSuperUser.adoc[leveloffset=+2]
222+
include::modules/api-superuser-deleteOrganizationQuotaSuperUser.adoc[leveloffset=+2]
223+
include::modules/api-superuser-createOrganizationQuotaSuperUser.adoc[leveloffset=+2]
224+
include::modules/api-superuser-listOrganizationQuotaSuperUser.adoc[leveloffset=+2]
225+
include::modules/api-superuser-changeOrganization.adoc[leveloffset=+2]
226+
include::modules/api-superuser-deleteOrganization.adoc[leveloffset=+2]
227+
include::modules/api-superuser-approveServiceKey.adoc[leveloffset=+2]
228+
include::modules/api-superuser-deleteServiceKey.adoc[leveloffset=+2]
229+
include::modules/api-superuser-updateServiceKey.adoc[leveloffset=+2]
230+
include::modules/api-superuser-getServiceKey.adoc[leveloffset=+2]
231+
include::modules/api-superuser-getRepoBuildStatusSuperUser.adoc[leveloffset=+2]
232+
include::modules/api-superuser-getRepoBuildSuperUser.adoc[leveloffset=+2]
233+
include::modules/api-superuser-getRepoBuildLogsSuperUser.adoc[leveloffset=+2]
234+
include::modules/api-superuser-getRegistrySize.adoc[leveloffset=+2]
235+
include::modules/api-superuser-postRegistrySize.adoc[leveloffset=+2]
236+
237+
//done
238+
include::modules/api-tag.adoc[leveloffset=+1]
239+
include::modules/api-tag-restoreTag.adoc[leveloffset=+2]
240+
include::modules/api-tag-changeTag.adoc[leveloffset=+2]
241+
include::modules/api-tag-deleteFullTag.adoc[leveloffset=+2]
242+
include::modules/api-tag-listRepoTags.adoc[leveloffset=+2]
243+
//done
244+
include::modules/api-team.adoc[leveloffset=+1]
245+
include::modules/api-team-getOrganizationTeamPermissions.adoc[leveloffset=+2]
246+
include::modules/api-team-updateOrganizationTeamMember.adoc[leveloffset=+2]
247+
include::modules/api-team-deleteOrganizationTeamMember.adoc[leveloffset=+2]
248+
include::modules/api-team-getOrganizationTeamMembers.adoc[leveloffset=+2]
249+
include::modules/api-team-inviteTeamMemberEmail.adoc[leveloffset=+2]
250+
include::modules/api-team-deleteTeamMemberEmailInvite.adoc[leveloffset=+2]
251+
include::modules/api-team-updateOrganizationTeam.adoc[leveloffset=+2]
252+
include::modules/api-team-deleteOrganizationTeam.adoc[leveloffset=+2]
253+
//done
254+
include::modules/api-trigger.adoc[leveloffset=+1]
255+
include::modules/api-trigger-activateBuildTrigger.adoc[leveloffset=+2]
256+
include::modules/api-trigger-listTriggerRecentBuilds.adoc[leveloffset=+2]
257+
include::modules/api-trigger-manuallyStartBuildTrigger.adoc[leveloffset=+2]
258+
include::modules/api-trigger-getBuildTrigger.adoc[leveloffset=+2]
259+
include::modules/api-trigger-updateBuildTrigger.adoc[leveloffset=+2]
260+
include::modules/api-trigger-deleteBuildTrigger.adoc[leveloffset=+2]
261+
include::modules/api-trigger-listBuildTriggers.adoc[leveloffset=+2]
262+
263+
//done
264+
include::modules/api-user.adoc[leveloffset=+1]
265+
include::modules/api-user-createStar.adoc[leveloffset=+2]
266+
include::modules/api-user-listStarredRepos.adoc[leveloffset=+2]
267+
include::modules/api-user-getLoggedInUser.adoc[leveloffset=+2]
268+
include::modules/api-user-deleteStar.adoc[leveloffset=+2]
269+
include::modules/api-user-getUserInformation.adoc[leveloffset=+2]
270+
271+
include::modules/api-definitions.adoc[leveloffset=+1]
272+
273+
////
274+
// do not remove
275+
[id="api-config-examples"]
276+
== API configuration examples
277+
278+
include::modules/external-registry-config-api-example.adoc[leveloffset=+2]
279+
include::modules/root-rule-config-api-example.adoc[leveloffset=+2]
280+
////

‎api_reference/modules

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../modules/

0 commit comments

Comments
 (0)