Skip to content

Commit e29c51e

Browse files
stevsmitSteven Smith
stevsmit
and
Steven Smith
authored
Updates a few API things (#1251)
Co-authored-by: Steven Smith <[email protected]>
1 parent cbaaebe commit e29c51e

File tree

4 files changed

+13
-273
lines changed

4 files changed

+13
-273
lines changed

‎api/master.adoc

+1-265
Original file line numberDiff line numberDiff line change
@@ -130,268 +130,4 @@ include::modules/deleting-team-within-organization-api.adoc[leveloffset=+3]
130130
//build
131131
include::modules/managing-builds-api.adoc[leveloffset=+2]
132132
//user
133-
include::modules/managing-user-options-api.adoc[leveloffset=+2]
134-
135-
136-
137-
//include::modules/proc_use-api.adoc[leveloffset=+1]
138-
139-
////
140-
== {productname} Application Programming Interface (API)
141-
[id="ref-api-quay"]
142-
143-
This API allows you to perform many of the operations required to work with {productname} repositories, users, and organizations.
144-
145-
include::modules/api-authorization.adoc[leveloffset=+2]
146-
147-
//example procedures provided
148-
include::modules/api-appspecifictokens.adoc[leveloffset=+2]
149-
include::modules/api-appspecifictokens-createAppToken.adoc[leveloffset=+3]
150-
include::modules/api-appspecifictokens-listAppTokens.adoc[leveloffset=+3]
151-
include::modules/api-appspecifictokens-getAppToken.adoc[leveloffset=+3]
152-
include::modules/api-appspecifictokens-revokeAppToken.adoc[leveloffset=+3]
153-
154-
include::modules/api-build.adoc[leveloffset=+2]
155-
include::modules/api-build-getRepoBuildStatus.adoc[leveloffset=+3]
156-
include::modules/api-build-getRepoBuildLogs.adoc[leveloffset=+3]
157-
include::modules/api-build-getRepoBuild.adoc[leveloffset=+3]
158-
include::modules/api-build-cancelRepoBuild.adoc[leveloffset=+3]
159-
include::modules/api-build-requestRepoBuild.adoc[leveloffset=+3]
160-
include::modules/api-build-getRepoBuilds.adoc[leveloffset=+3]
161-
162-
//example procedures provided
163-
include::modules/api-discovery.adoc[leveloffset=+2]
164-
include::modules/api-discovery-discovery.adoc[leveloffset=+3]
165-
166-
//example procedures provided
167-
include::modules/api-error.adoc[leveloffset=+2]
168-
include::modules/api-error-getErrorDescription.adoc[leveloffset=+3]
169-
170-
//example procedures provided
171-
include::modules/api-globalmessages.adoc[leveloffset=+2]
172-
include::modules/api-globalmessages-createGlobalMessage.adoc[leveloffset=+3]
173-
include::modules/api-globalmessages-getGlobalMessages.adoc[leveloffset=+3]
174-
include::modules/api-globalmessages-deleteGlobalMessage.adoc[leveloffset=+3]
175-
176-
//example procedures provided
177-
include::modules/api-logs.adoc[leveloffset=+2]
178-
include::modules/api-logs-getAggregateUserLogs.adoc[leveloffset=+3]
179-
include::modules/api-logs-exportUserLogs.adoc[leveloffset=+3]
180-
include::modules/api-logs-listUserLogs.adoc[leveloffset=+3]
181-
include::modules/api-logs-getAggregateOrgLogs.adoc[leveloffset=+3]
182-
include::modules/api-logs-exportOrgLogs.adoc[leveloffset=+3]
183-
include::modules/api-logs-listOrgLogs.adoc[leveloffset=+3]
184-
include::modules/api-logs-getAggregateRepoLogs.adoc[leveloffset=+3]
185-
include::modules/api-logs-exportRepoLogs.adoc[leveloffset=+3]
186-
include::modules/api-logs-listRepoLogs.adoc[leveloffset=+3]
187-
188-
//example procedures provided
189-
include::modules/api-manifest.adoc[leveloffset=+2]
190-
include::modules/api-manifest-getManifestLabel.adoc[leveloffset=+3]
191-
include::modules/api-manifest-deleteManifestLabel.adoc[leveloffset=+3]
192-
include::modules/api-manifest-addManifestLabel.adoc[leveloffset=+3]
193-
include::modules/api-manifest-listManifestLabels.adoc[leveloffset=+3]
194-
include::modules/api-manifest-getRepoManifest.adoc[leveloffset=+3]
195-
196-
//example procedures provided
197-
include::modules/api-mirror.adoc[leveloffset=+2]
198-
include::modules/api-mirror-syncCancel.adoc[leveloffset=+3]
199-
include::modules/api-mirror-syncNow.adoc[leveloffset=+3]
200-
include::modules/api-mirror-getRepoMirrorConfig.adoc[leveloffset=+3]
201-
include::modules/api-mirror-changeRepoMirrorConfig.adoc[leveloffset=+3]
202-
include::modules/api-mirror-createRepoMirrorConfig.adoc[leveloffset=+3]
203-
204-
//commands provided
205-
include::modules/api-namespacequota.adoc[leveloffset=+2]
206-
include::modules/api-namespacequota-listUserQuota.adoc[leveloffset=+3]
207-
include::modules/api-namespacequota-getOrganizationQuotaLimit.adoc[leveloffset=+3]
208-
include::modules/api-namespacequota-changeOrganizationQuotaLimit.adoc[leveloffset=+3]
209-
include::modules/api-namespacequota-deleteOrganizationQuotaLimit.adoc[leveloffset=+3]
210-
include::modules/api-namespacequota-createOrganizationQuotaLimit.adoc[leveloffset=+3]
211-
include::modules/api-namespacequota-listOrganizationQuotaLimit.adoc[leveloffset=+3]
212-
include::modules/api-namespacequota-getUserQuotaLimit.adoc[leveloffset=+3]
213-
include::modules/api-namespacequota-listUserQuotaLimit.adoc[leveloffset=+3]
214-
include::modules/api-namespacequota-getOrganizationQuota.adoc[leveloffset=+3]
215-
include::modules/api-namespacequota-changeOrganizationQuota.adoc[leveloffset=+3]
216-
include::modules/api-namespacequota-deleteOrganizationQuota.adoc[leveloffset=+3]
217-
include::modules/api-namespacequota-createOrganizationQuota.adoc[leveloffset=+3]
218-
include::modules/api-namespacequota-listOrganizationQuota.adoc[leveloffset=+3]
219-
include::modules/api-namespacequota-getUserQuota.adoc[leveloffset=+3]
220-
221-
//done
222-
include::modules/api-organization.adoc[leveloffset=+2]
223-
include::modules/api-organization-createOrganization.adoc[leveloffset=+3]
224-
include::modules/api-organization-validateProxyCacheConfig.adoc[leveloffset=+3]
225-
include::modules/api-organization-getOrganizationCollaborators.adoc[leveloffset=+3]
226-
include::modules/api-organization-getOrganizationApplication.adoc[leveloffset=+3]
227-
include::modules/api-organization-updateOrganizationApplication.adoc[leveloffset=+3]
228-
include::modules/api-organization-deleteOrganizationApplication.adoc[leveloffset=+3]
229-
include::modules/api-organization-createOrganizationApplication.adoc[leveloffset=+3]
230-
include::modules/api-organization-getOrganizationApplications.adoc[leveloffset=+3]
231-
include::modules/api-organization-getProxyCacheConfig.adoc[leveloffset=+3]
232-
include::modules/api-organization-deleteProxyCacheConfig.adoc[leveloffset=+3]
233-
include::modules/api-organization-createProxyCacheConfig.adoc[leveloffset=+3]
234-
include::modules/api-organization-getOrganizationMember.adoc[leveloffset=+3]
235-
include::modules/api-organization-removeOrganizationMember.adoc[leveloffset=+3]
236-
include::modules/api-organization-getOrganizationMembers.adoc[leveloffset=+3]
237-
include::modules/api-organization-getOrganization.adoc[leveloffset=+3]
238-
include::modules/api-organization-changeOrganizationDetails.adoc[leveloffset=+3]
239-
include::modules/api-organization-deleteAdminedOrganization.adoc[leveloffset=+3]
240-
include::modules/api-organization-getApplicationInformation.adoc[leveloffset=+3]
241-
//done
242-
include::modules/api-permission.adoc[leveloffset=+2]
243-
include::modules/api-permission-getUserTransitivePermission.adoc[leveloffset=+3]
244-
include::modules/api-permission-getUserPermissions.adoc[leveloffset=+3]
245-
include::modules/api-permission-changeUserPermissions.adoc[leveloffset=+3]
246-
include::modules/api-permission-deleteUserPermissions.adoc[leveloffset=+3]
247-
include::modules/api-permission-getTeamPermissions.adoc[leveloffset=+3]
248-
include::modules/api-permission-changeTeamPermissions.adoc[leveloffset=+3]
249-
include::modules/api-permission-deleteTeamPermissions.adoc[leveloffset=+3]
250-
include::modules/api-permission-listRepoTeamPermissions.adoc[leveloffset=+3]
251-
include::modules/api-permission-listRepoUserPermissions.adoc[leveloffset=+3]
252-
//done but might need example procs
253-
include::modules/api-policy.adoc[leveloffset=+2]
254-
include::modules/api-policy-createOrganizationAutoPrunePolicy.adoc[leveloffset=+3]
255-
include::modules/api-policy-listOrganizationAutoPrunePolicies.adoc[leveloffset=+3]
256-
include::modules/api-policy-getOrganizationAutoPrunePolicy.adoc[leveloffset=+3]
257-
include::modules/api-policy-deleteOrganizationAutoPrunePolicy.adoc[leveloffset=+3]
258-
include::modules/api-policy-updateOrganizationAutoPrunePolicy.adoc[leveloffset=+3]
259-
include::modules/api-policy-createRepositoryAutoPrunePolicy.adoc[leveloffset=+3]
260-
include::modules/api-policy-listRepositoryAutoPrunePolicies.adoc[leveloffset=+3]
261-
include::modules/api-policy-getRepositoryAutoPrunePolicy.adoc[leveloffset=+3]
262-
include::modules/api-policy-deleteRepositoryAutoPrunePolicy.adoc[leveloffset=+3]
263-
include::modules/api-policy-updateRepositoryAutoPrunePolicy.adoc[leveloffset=+3]
264-
include::modules/api-policy-createUserAutoPrunePolicy.adoc[leveloffset=+3]
265-
include::modules/api-policy-listUserAutoPrunePolicies.adoc[leveloffset=+3]
266-
include::modules/api-policy-getUserAutoPrunePolicy.adoc[leveloffset=+3]
267-
include::modules/api-policy-deleteUserAutoPrunePolicy.adoc[leveloffset=+3]
268-
include::modules/api-policy-updateUserAutoPrunePolicy.adoc[leveloffset=+3]
269-
270-
//done
271-
include::modules/api-prototype.adoc[leveloffset=+2]
272-
include::modules/api-prototype-updateOrganizationPrototypePermission.adoc[leveloffset=+3]
273-
include::modules/api-prototype-deleteOrganizationPrototypePermission.adoc[leveloffset=+3]
274-
include::modules/api-prototype-createOrganizationPrototypePermission.adoc[leveloffset=+3]
275-
include::modules/api-prototype-getOrganizationPrototypePermissions.adoc[leveloffset=+3]
276-
//won't do
277-
include::modules/api-referrers.adoc[leveloffset=+2]
278-
include::modules/api-referrers-getReferrers.adoc[leveloffset=+3]
279-
280-
//done
281-
include::modules/api-repository.adoc[leveloffset=+2]
282-
//do not edit
283-
include::modules/api-repository-createRepo.adoc[leveloffset=+3]
284-
include::modules/api-repository-listRepos.adoc[leveloffset=+3]
285-
include::modules/api-repository-changeRepoVisibility.adoc[leveloffset=+3]
286-
include::modules/api-repository-changeRepoState.adoc[leveloffset=+3]
287-
include::modules/api-repository-getRepo.adoc[leveloffset=+3]
288-
include::modules/api-repository-updateRepo.adoc[leveloffset=+3]
289-
include::modules/api-repository-deleteRepository.adoc[leveloffset=+3]
290-
291-
//done
292-
include::modules/api-repositorynotification.adoc[leveloffset=+2]
293-
include::modules/api-repositorynotification-testRepoNotification.adoc[leveloffset=+3]
294-
include::modules/api-repositorynotification-getRepoNotification.adoc[leveloffset=+3]
295-
include::modules/api-repositorynotification-deleteRepoNotification.adoc[leveloffset=+3]
296-
include::modules/api-repositorynotification-resetRepositoryNotificationFailures.adoc[leveloffset=+3]
297-
include::modules/api-repositorynotification-createRepoNotification.adoc[leveloffset=+3]
298-
include::modules/api-repositorynotification-listRepoNotifications.adoc[leveloffset=+3]
299-
//done
300-
include::modules/api-robot.adoc[leveloffset=+2]
301-
include::modules/api-robot-getUserRobots.adoc[leveloffset=+3]
302-
include::modules/api-robot-getOrgRobotPermissions.adoc[leveloffset=+3]
303-
include::modules/api-robot-regenerateOrgRobotToken.adoc[leveloffset=+3]
304-
include::modules/api-robot-getUserRobotPermissions.adoc[leveloffset=+3]
305-
include::modules/api-robot-regenerateUserRobotToken.adoc[leveloffset=+3]
306-
include::modules/api-robot-getOrgRobot.adoc[leveloffset=+3]
307-
include::modules/api-robot-createOrgRobot.adoc[leveloffset=+3]
308-
include::modules/api-robot-deleteOrgRobot.adoc[leveloffset=+3]
309-
include::modules/api-robot-getOrgRobots.adoc[leveloffset=+3]
310-
include::modules/api-robot-getUserRobot.adoc[leveloffset=+3]
311-
include::modules/api-robot-createUserRobot.adoc[leveloffset=+3]
312-
include::modules/api-robot-deleteUserRobot.adoc[leveloffset=+3]
313-
include::modules/api-robot-getOrgRobotFederation.adoc[leveloffset=+3]
314-
include::modules/api-robot-createOrgRobotFederation.adoc[leveloffset=+3]
315-
//include::modules/api-robot-deleteOrgRobotFederation.adoc[leveloffset=+3]
316-
317-
//done
318-
include::modules/api-search.adoc[leveloffset=+2]
319-
include::modules/api-search-conductRepoSearch.adoc[leveloffset=+3]
320-
include::modules/api-search-conductSearch.adoc[leveloffset=+3]
321-
include::modules/api-search-getMatchingEntities.adoc[leveloffset=+3]
322-
323-
//done
324-
include::modules/api-secscan.adoc[leveloffset=+2]
325-
include::modules/api-secscan-getRepoManifestSecurity.adoc[leveloffset=+3]
326-
//done
327-
include::modules/api-superuser.adoc[leveloffset=+2]
328-
include::modules/api-superuser-createInstallUser.adoc[leveloffset=+3]
329-
include::modules/api-superuser-deleteInstallUser.adoc[leveloffset=+3]
330-
include::modules/api-superuser-listAllUsers.adoc[leveloffset=+3]
331-
include::modules/api-superuser-listAllLogs.adoc[leveloffset=+3]
332-
include::modules/api-superuser-listAllOrganizations.adoc[leveloffset=+3]
333-
include::modules/api-superuser-createServiceKey.adoc[leveloffset=+3]
334-
include::modules/api-superuser-listServiceKeys.adoc[leveloffset=+3]
335-
include::modules/api-superuser-changeUserQuotaSuperUser.adoc[leveloffset=+3]
336-
include::modules/api-superuser-deleteUserQuotaSuperUser.adoc[leveloffset=+3]
337-
include::modules/api-superuser-createUserQuotaSuperUser.adoc[leveloffset=+3]
338-
include::modules/api-superuser-listUserQuotaSuperUser.adoc[leveloffset=+3]
339-
include::modules/api-superuser-changeOrganizationQuotaSuperUser.adoc[leveloffset=+3]
340-
include::modules/api-superuser-deleteOrganizationQuotaSuperUser.adoc[leveloffset=+3]
341-
include::modules/api-superuser-createOrganizationQuotaSuperUser.adoc[leveloffset=+3]
342-
include::modules/api-superuser-listOrganizationQuotaSuperUser.adoc[leveloffset=+3]
343-
include::modules/api-superuser-changeOrganization.adoc[leveloffset=+3]
344-
include::modules/api-superuser-deleteOrganization.adoc[leveloffset=+3]
345-
include::modules/api-superuser-approveServiceKey.adoc[leveloffset=+3]
346-
include::modules/api-superuser-deleteServiceKey.adoc[leveloffset=+3]
347-
include::modules/api-superuser-updateServiceKey.adoc[leveloffset=+3]
348-
include::modules/api-superuser-getServiceKey.adoc[leveloffset=+3]
349-
include::modules/api-superuser-getRepoBuildStatusSuperUser.adoc[leveloffset=+3]
350-
include::modules/api-superuser-getRepoBuildSuperUser.adoc[leveloffset=+3]
351-
include::modules/api-superuser-getRepoBuildLogsSuperUser.adoc[leveloffset=+3]
352-
include::modules/api-superuser-getRegistrySize.adoc[leveloffset=+3]
353-
include::modules/api-superuser-postRegistrySize.adoc[leveloffset=+3]
354-
355-
//done
356-
include::modules/api-tag.adoc[leveloffset=+2]
357-
include::modules/api-tag-restoreTag.adoc[leveloffset=+3]
358-
include::modules/api-tag-changeTag.adoc[leveloffset=+3]
359-
include::modules/api-tag-deleteFullTag.adoc[leveloffset=+3]
360-
include::modules/api-tag-listRepoTags.adoc[leveloffset=+3]
361-
//done
362-
include::modules/api-team.adoc[leveloffset=+2]
363-
include::modules/api-team-getOrganizationTeamPermissions.adoc[leveloffset=+3]
364-
include::modules/api-team-updateOrganizationTeamMember.adoc[leveloffset=+3]
365-
include::modules/api-team-deleteOrganizationTeamMember.adoc[leveloffset=+3]
366-
include::modules/api-team-getOrganizationTeamMembers.adoc[leveloffset=+3]
367-
include::modules/api-team-inviteTeamMemberEmail.adoc[leveloffset=+3]
368-
include::modules/api-team-deleteTeamMemberEmailInvite.adoc[leveloffset=+3]
369-
include::modules/api-team-updateOrganizationTeam.adoc[leveloffset=+3]
370-
include::modules/api-team-deleteOrganizationTeam.adoc[leveloffset=+3]
371-
//done
372-
include::modules/api-trigger.adoc[leveloffset=+2]
373-
include::modules/api-trigger-activateBuildTrigger.adoc[leveloffset=+3]
374-
include::modules/api-trigger-listTriggerRecentBuilds.adoc[leveloffset=+3]
375-
include::modules/api-trigger-manuallyStartBuildTrigger.adoc[leveloffset=+3]
376-
include::modules/api-trigger-getBuildTrigger.adoc[leveloffset=+3]
377-
include::modules/api-trigger-updateBuildTrigger.adoc[leveloffset=+3]
378-
include::modules/api-trigger-deleteBuildTrigger.adoc[leveloffset=+3]
379-
include::modules/api-trigger-listBuildTriggers.adoc[leveloffset=+3]
380-
381-
//done
382-
include::modules/api-user.adoc[leveloffset=+2]
383-
include::modules/api-user-createStar.adoc[leveloffset=+3]
384-
include::modules/api-user-listStarredRepos.adoc[leveloffset=+3]
385-
include::modules/api-user-getLoggedInUser.adoc[leveloffset=+3]
386-
include::modules/api-user-deleteStar.adoc[leveloffset=+3]
387-
include::modules/api-user-getUserInformation.adoc[leveloffset=+3]
388-
389-
include::modules/api-definitions.adoc[leveloffset=+2]
390-
391-
// do not remove
392-
[id="api-config-examples"]
393-
== API configuration examples
394-
395-
include::modules/external-registry-config-api-example.adoc[leveloffset=+2]
396-
include::modules/root-rule-config-api-example.adoc[leveloffset=+2]
397-
////
133+
include::modules/managing-user-options-api.adoc[leveloffset=+2]

‎modules/quay-error-details.adoc

+6-6
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ Use the following procedure to discover error details.
1616
+
1717
[options="header", width=100%, cols=".^2a,.^14a,.^4a"]
1818
|===
19-
|HTTP Code|Description|Schema
20-
|200|Successful invocation|&lt;&lt;_apierrordescription,ApiErrorDescription&gt;&gt;
21-
|400|Bad Request|&lt;&lt;_apierror,ApiError&gt;&gt;
22-
|401|Session required|&lt;&lt;_apierror,ApiError&gt;&gt;
23-
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
24-
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
19+
|HTTP Code|Description
20+
|200|Successful invocation
21+
|400|Bad Request
22+
|401|Session required
23+
|403|Unauthorized access
24+
|404|Not found
2525
|===
2626
+
2727
[source,terminal]

‎modules/rn_3_14_0.adoc

+5-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,11 @@ Issued 2025-03-27
1616

1717
The following documentation changes have been made with the {productname} 3.14 release:
1818

19-
* The {productname} API guide . . .
19+
* The {productname} API guide has been updated and split into two books:
20+
21+
** link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index[{productname} API guide]. This book contains an overview of the {productname} API, an overview of token types (OAuth 2.0 access tokens, robot account tokens, and OCI referrers OAuth access tokens), how to enable and use the {productname} API, suggestions for token management, and example commands for leveraging API endpoints to execute commands. This book is useful if you are new to the {productname} API or want information about its token types and how to leverage the API.
22+
23+
** link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_reference/index[{productname} API reference]. This book contains all API reference endpoints and accompanying example commands for those endpoints. This book is useful if you are already familiar with using the {productname} API.
2024

2125
[id="new-features-and-enhancements-314"]
2226
== {productname} new features and enhancements

‎modules/using-the-api.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ $ curl -X GET -H "Authorization: Bearer <your_access_token>" <1>
1212
<1> The OAuth 2 access token that was generated through the {productname} UI.
1313
<2> The URL of your {productname} deployment and the desired API endpoint.
1414

15-
All {productname} APIs are documented in the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#red_hat_quay_application_programming_interface_api[Application Programming Interface (API)] chapter. Understanding how they are documented is crucial to successful invocation. Take, for example, the following entry for the `createAppToken` API endpoint:
15+
All {productname} APIs are documented in the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_reference/index#red_hat_quay_application_programming_interface_api[Application Programming Interface (API)] chapter. Understanding how they are documented is crucial to successful invocation. Take, for example, the following entry for the `createAppToken` API endpoint:
1616

1717
[source,text]
1818
----

0 commit comments

Comments
 (0)