Skip to content

Commit f878a40

Browse files
stevsmitSteven Smith
stevsmit
and
Steven Smith
authored
Adds final API commands to guide (quay#1231)
Co-authored-by: Steven Smith <[email protected]>
1 parent 7c1b533 commit f878a40

File tree

105 files changed

+1076
-17
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+1076
-17
lines changed

‎api/master.adoc‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ include::modules/api-mirror-getRepoMirrorConfig.adoc[leveloffset=+3]
201201
include::modules/api-mirror-changeRepoMirrorConfig.adoc[leveloffset=+3]
202202
include::modules/api-mirror-createRepoMirrorConfig.adoc[leveloffset=+3]
203203
204-
//example procedures provided -- needs example commands
204+
//commands provided
205205
include::modules/api-namespacequota.adoc[leveloffset=+2]
206206
include::modules/api-namespacequota-listUserQuota.adoc[leveloffset=+3]
207207
include::modules/api-namespacequota-getOrganizationQuotaLimit.adoc[leveloffset=+3]
@@ -218,8 +218,7 @@ include::modules/api-namespacequota-createOrganizationQuota.adoc[leveloffset=+3]
218218
include::modules/api-namespacequota-listOrganizationQuota.adoc[leveloffset=+3]
219219
include::modules/api-namespacequota-getUserQuota.adoc[leveloffset=+3]
220220
221-
//example procedures provided -- needs example commands
222-
221+
//done
223222
include::modules/api-organization.adoc[leveloffset=+2]
224223
include::modules/api-organization-createOrganization.adoc[leveloffset=+3]
225224
include::modules/api-organization-validateProxyCacheConfig.adoc[leveloffset=+3]
@@ -239,7 +238,7 @@ include::modules/api-organization-getOrganization.adoc[leveloffset=+3]
239238
include::modules/api-organization-changeOrganizationDetails.adoc[leveloffset=+3]
240239
include::modules/api-organization-deleteAdminedOrganization.adoc[leveloffset=+3]
241240
include::modules/api-organization-getApplicationInformation.adoc[leveloffset=+3]
242-
241+
//done
243242
include::modules/api-permission.adoc[leveloffset=+2]
244243
include::modules/api-permission-getUserTransitivePermission.adoc[leveloffset=+3]
245244
include::modules/api-permission-getUserPermissions.adoc[leveloffset=+3]
@@ -250,7 +249,7 @@ include::modules/api-permission-changeTeamPermissions.adoc[leveloffset=+3]
250249
include::modules/api-permission-deleteTeamPermissions.adoc[leveloffset=+3]
251250
include::modules/api-permission-listRepoTeamPermissions.adoc[leveloffset=+3]
252251
include::modules/api-permission-listRepoUserPermissions.adoc[leveloffset=+3]
253-
252+
//done but might need example procs
254253
include::modules/api-policy.adoc[leveloffset=+2]
255254
include::modules/api-policy-createOrganizationAutoPrunePolicy.adoc[leveloffset=+3]
256255
include::modules/api-policy-listOrganizationAutoPrunePolicies.adoc[leveloffset=+3]
@@ -268,15 +267,17 @@ include::modules/api-policy-getUserAutoPrunePolicy.adoc[leveloffset=+3]
268267
include::modules/api-policy-deleteUserAutoPrunePolicy.adoc[leveloffset=+3]
269268
include::modules/api-policy-updateUserAutoPrunePolicy.adoc[leveloffset=+3]
270269
270+
//done
271271
include::modules/api-prototype.adoc[leveloffset=+2]
272272
include::modules/api-prototype-updateOrganizationPrototypePermission.adoc[leveloffset=+3]
273273
include::modules/api-prototype-deleteOrganizationPrototypePermission.adoc[leveloffset=+3]
274274
include::modules/api-prototype-createOrganizationPrototypePermission.adoc[leveloffset=+3]
275275
include::modules/api-prototype-getOrganizationPrototypePermissions.adoc[leveloffset=+3]
276-
276+
//won't do
277277
include::modules/api-referrers.adoc[leveloffset=+2]
278278
include::modules/api-referrers-getReferrers.adoc[leveloffset=+3]
279279
280+
//done
280281
include::modules/api-repository.adoc[leveloffset=+2]
281282
//do not edit
282283
include::modules/api-repository-createRepo.adoc[leveloffset=+3]
@@ -287,14 +288,15 @@ include::modules/api-repository-getRepo.adoc[leveloffset=+3]
287288
include::modules/api-repository-updateRepo.adoc[leveloffset=+3]
288289
include::modules/api-repository-deleteRepository.adoc[leveloffset=+3]
289290
291+
//done
290292
include::modules/api-repositorynotification.adoc[leveloffset=+2]
291293
include::modules/api-repositorynotification-testRepoNotification.adoc[leveloffset=+3]
292294
include::modules/api-repositorynotification-getRepoNotification.adoc[leveloffset=+3]
293295
include::modules/api-repositorynotification-deleteRepoNotification.adoc[leveloffset=+3]
294296
include::modules/api-repositorynotification-resetRepositoryNotificationFailures.adoc[leveloffset=+3]
295297
include::modules/api-repositorynotification-createRepoNotification.adoc[leveloffset=+3]
296298
include::modules/api-repositorynotification-listRepoNotifications.adoc[leveloffset=+3]
297-
299+
//done
298300
include::modules/api-robot.adoc[leveloffset=+2]
299301
include::modules/api-robot-getUserRobots.adoc[leveloffset=+3]
300302
include::modules/api-robot-getOrgRobotPermissions.adoc[leveloffset=+3]
@@ -312,15 +314,16 @@ include::modules/api-robot-getOrgRobotFederation.adoc[leveloffset=+3]
312314
include::modules/api-robot-createOrgRobotFederation.adoc[leveloffset=+3]
313315
//include::modules/api-robot-deleteOrgRobotFederation.adoc[leveloffset=+3]
314316
315-
317+
//done
316318
include::modules/api-search.adoc[leveloffset=+2]
317319
include::modules/api-search-conductRepoSearch.adoc[leveloffset=+3]
318320
include::modules/api-search-conductSearch.adoc[leveloffset=+3]
319321
include::modules/api-search-getMatchingEntities.adoc[leveloffset=+3]
320322
323+
//done
321324
include::modules/api-secscan.adoc[leveloffset=+2]
322325
include::modules/api-secscan-getRepoManifestSecurity.adoc[leveloffset=+3]
323-
326+
//done
324327
include::modules/api-superuser.adoc[leveloffset=+2]
325328
include::modules/api-superuser-createInstallUser.adoc[leveloffset=+3]
326329
include::modules/api-superuser-deleteInstallUser.adoc[leveloffset=+3]
@@ -349,12 +352,13 @@ include::modules/api-superuser-getRepoBuildLogsSuperUser.adoc[leveloffset=+3]
349352
include::modules/api-superuser-getRegistrySize.adoc[leveloffset=+3]
350353
include::modules/api-superuser-postRegistrySize.adoc[leveloffset=+3]
351354
355+
//done
352356
include::modules/api-tag.adoc[leveloffset=+2]
353357
include::modules/api-tag-restoreTag.adoc[leveloffset=+3]
354358
include::modules/api-tag-changeTag.adoc[leveloffset=+3]
355359
include::modules/api-tag-deleteFullTag.adoc[leveloffset=+3]
356360
include::modules/api-tag-listRepoTags.adoc[leveloffset=+3]
357-
361+
//done
358362
include::modules/api-team.adoc[leveloffset=+2]
359363
include::modules/api-team-getOrganizationTeamPermissions.adoc[leveloffset=+3]
360364
include::modules/api-team-updateOrganizationTeamMember.adoc[leveloffset=+3]
@@ -364,7 +368,7 @@ include::modules/api-team-inviteTeamMemberEmail.adoc[leveloffset=+3]
364368
include::modules/api-team-deleteTeamMemberEmailInvite.adoc[leveloffset=+3]
365369
include::modules/api-team-updateOrganizationTeam.adoc[leveloffset=+3]
366370
include::modules/api-team-deleteOrganizationTeam.adoc[leveloffset=+3]
367-
371+
//done
368372
include::modules/api-trigger.adoc[leveloffset=+2]
369373
include::modules/api-trigger-activateBuildTrigger.adoc[leveloffset=+3]
370374
include::modules/api-trigger-listTriggerRecentBuilds.adoc[leveloffset=+3]
@@ -374,6 +378,7 @@ include::modules/api-trigger-updateBuildTrigger.adoc[leveloffset=+3]
374378
include::modules/api-trigger-deleteBuildTrigger.adoc[leveloffset=+3]
375379
include::modules/api-trigger-listBuildTriggers.adoc[leveloffset=+3]
376380
381+
//done
377382
include::modules/api-user.adoc[leveloffset=+2]
378383
include::modules/api-user-createStar.adoc[leveloffset=+3]
379384
include::modules/api-user-listStarredRepos.adoc[leveloffset=+3]
@@ -383,9 +388,11 @@ include::modules/api-user-getUserInformation.adoc[leveloffset=+3]
383388
384389
include::modules/api-definitions.adoc[leveloffset=+2]
385390
391+
////
386392
// do not remove
387393
[id="api-config-examples"]
388394
== API configuration examples
389395
390396
include::modules/external-registry-config-api-example.adoc[leveloffset=+2]
391397
include::modules/root-rule-config-api-example.adoc[leveloffset=+2]
398+
////

‎modules/adjusting-repository-access-via-the-api.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The visibility of your repository can be set to `private` or `public` by using t
2222
[source,terminal]
2323
----
2424
$ curl -X POST \
25-
-H "Authorization: Bearer GCczXwaZ5i21p8hOO09uZqjZSsTYGKteu5PC5UuA" \
25+
-H "Authorization: Bearer <bearer_token>" \
2626
-H "Content-Type: application/json" \
2727
-d '{
2828
"visibility": "private"

‎modules/api-namespacequota-changeOrganizationQuota.adoc‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,17 @@ _optional_|Human readable storage capacity of the organization. Accepts SI units
5252
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
5353
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
5454
|===
55+
56+
57+
[discrete]
58+
== Example command
59+
60+
[source,terminal]
61+
----
62+
$ curl -X PUT "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>" \
63+
-H "Authorization: Bearer <access_token>" \
64+
-H "Content-Type: application/json" \
65+
-d '{
66+
"limit_bytes": <limit_in_bytes>
67+
}'
68+
----

‎modules/api-namespacequota-changeOrganizationQuotaLimit.adoc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,18 @@ _optional_|Quota threshold, in percent of quota|integer
5252
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
5353
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
5454
|===
55+
56+
57+
[discrete]
58+
== Example command
59+
60+
[source,terminal]
61+
----
62+
$ curl -X PUT "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>/limit/<limit_id>" \
63+
-H "Authorization: Bearer <access_token>" \
64+
-H "Content-Type: application/json" \
65+
-d '{
66+
"type": "<type>",
67+
"threshold_percent": <threshold_percent>
68+
}'
69+
----

‎modules/api-namespacequota-createOrganizationQuota.adoc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,3 +49,18 @@ _optional_|Human readable storage capacity of the organization. Accepts SI units
4949
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
5050
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
5151
|===
52+
53+
54+
[discrete]
55+
== Example command
56+
57+
[source,terminal]
58+
----
59+
$ curl -X POST "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota" \
60+
-H "Authorization: Bearer <access_token>" \
61+
-H "Content-Type: application/json" \
62+
-d '{
63+
"limit_bytes": 10737418240,
64+
"limits": "10 Gi"
65+
}'
66+
----

‎modules/api-namespacequota-createOrganizationQuotaLimit.adoc‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,19 @@ _required_|Quota threshold, in percent of quota|integer
5050
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
5151
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
5252
|===
53+
54+
55+
[discrete]
56+
== Example command
57+
58+
[source,terminal]
59+
----
60+
$ curl -X POST "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>/limit" \
61+
-H "Authorization: Bearer <access_token>" \
62+
-H "Content-Type: application/json" \
63+
-d '{
64+
"limit_bytes": 21474836480,
65+
"type": "Reject", <1>
66+
"threshold_percent": 90 <2>
67+
}'
68+
----

‎modules/api-namespacequota-deleteOrganizationQuota.adoc‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,13 @@ _required_||string
3535
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
3636
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
3737
|===
38+
39+
40+
[discrete]
41+
== Example command
42+
43+
[source,terminal]
44+
----
45+
$ curl -X DELETE "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>" \
46+
-H "Authorization: Bearer <access_token>"
47+
----

‎modules/api-namespacequota-deleteOrganizationQuotaLimit.adoc‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,13 @@ _required_||string
3737
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
3838
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
3939
|===
40+
41+
42+
[discrete]
43+
== Example command
44+
45+
[source,terminal]
46+
----
47+
$ curl -X DELETE "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>/limit/<limit_id>" \
48+
-H "Authorization: Bearer <access_token>"
49+
----

‎modules/api-namespacequota-getOrganizationQuota.adoc‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,13 @@ _required_||string
3333
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
3434
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
3535
|===
36+
37+
38+
[discrete]
39+
== Example command
40+
41+
[source,terminal]
42+
----
43+
$ curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>" \
44+
-H "Authorization: Bearer <access_token>"S
45+
----

‎modules/api-namespacequota-getOrganizationQuotaLimit.adoc‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,13 @@ _required_||string
3535
|403|Unauthorized access|&lt;&lt;_apierror,ApiError&gt;&gt;
3636
|404|Not found|&lt;&lt;_apierror,ApiError&gt;&gt;
3737
|===
38+
39+
40+
[discrete]
41+
== Example command
42+
43+
[source,terminal]
44+
----
45+
$ curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>/limit/<limit_id>" \
46+
-H "Authorization: Bearer <access_token>"
47+
----

0 commit comments

Comments
 (0)