Build api (quay#1230)

* Adds user api endpoints (quay#1229)

Co-authored-by: Steven Smith <[email protected]>

* Adds build API endpoints

---------

Co-authored-by: Steven Smith <[email protected]>

Author: stevsmit

api/master.adoc

@@ -127,6 +127,10 @@ include::modules/managing-teams-api.adoc[leveloffset=+2]
 include::modules/managing-team-members-api.adoc[leveloffset=+3]
 include::modules/setting-role-of-team-within-organization-api.adoc[leveloffset=+3]
 include::modules/deleting-team-within-organization-api.adoc[leveloffset=+3]
+//build
+include::modules/managing-builds-api.adoc[leveloffset=+2]
+//user
+include::modules/managing-user-options-api.adoc[leveloffset=+2]
 
 
 

modules/managing-builds-api.adoc

@@ -0,0 +1,84 @@
+[id="manage-builds-api"]
+= Managing builds by using the {productname} API
+
+Builds can be managed by using the {productname} API.
+
+.Procedure
+
+. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#listbuildtriggers[`GET /api/v1/repository/{repository}/trigger/`] endpoint to list the triggers for the specified repository:
++
+[source,terminal]
+----
+$ curl -X GET "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/" \
+  -H "Authorization: Bearer <your_access_token>"
+----
++
+.Example output
++
+[source,terminal]
+----
+{"triggers": [{"id": "32ca5eae-a29f-46c7-8f44-3221ca417c92", "service": "custom-git", "is_active": false, "build_source": null, "repository_url": null, "config": {}, "can_invoke": true, "enabled": true, "disabled_reason": null}]}
+----
+
+. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#activatebuildtrigger[`POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/activate`] endpoint to activate the specified build trigger.
++
+[source,terminal]
+----
+$ curl -X POST "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid/activate" \
+  -H "Authorization: Bearer <your_access_token>" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "config": {
+      "branch": "main"
+    },
+    "pull_robot": "example+robot"
+  }'
+----
+
+. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#manuallystartbuildtrigger[`POST /api/v1/repository/{repository}/trigger/{trigger_uuid}/start`] endpoint to manually start the build from the specified trigger:
++
+[source,terminal]
+----
+$ curl -X POST "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid/start" \
+  -H "Authorization: Bearer <your_access_token>" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "branch_name": "main",
+    "commit_sha": "abcdef1234567890",
+    "refs": "refs/heads/main"
+  }'
+----
+
+. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#listtriggerrecentbuilds[`GET /api/v1/repository/{repository}/trigger/{trigger_uuid}/builds`] endpoint to list the builds started by the specified trigger:
++
+[source,terminal]
+----
+$ curl -X GET "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid/builds?limit=10" \
+  -H "Authorization: Bearer <your_access_token>"
+----
+
+. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#getbuildtrigger[`GET /api/v1/repository/{repository}/trigger/{trigger_uuid}`] endpoint to get information for the specified build trigger:
++
+[source,terminal]
+----
+$ curl -X GET "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid" \
+  -H "Authorization: Bearer <your_access_token>"
+----
+
+. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#updatebuildtrigger[`PUT /api/v1/repository/{repository}/trigger/{trigger_uuid}`] endpoint to update the specified build trigger:
++
+[source,terminal]
+----
+$ curl -X PUT "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid" \
+  -H "Authorization: Bearer <your_access_token>" \
+  -H "Content-Type: application/json" \
+  -d '{"enabled": true}'
+----
+
+. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#deletebuildtrigger[`DELETE /api/v1/repository/{repository}/trigger/{trigger_uuid}`] endpoint to delete the specified build trigger:
++
+[source,terminal]
+----
+$ curl -X DELETE "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/trigger/example-trigger-uuid" \
+  -H "Authorization: Bearer <your_access_token>"
+----

modules/managing-user-options-api.adoc

@@ -5,7 +5,7 @@ Some user options, like starring a repository, or getting information about your
 
 .Procedure
 
-. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/3.13/html-single/red_hat_quay_api_guide/index#getloggedinuser[`GET /api/v1/user/`] endpoint to get user information for the authenticated user.
+. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#getloggedinuser[`GET /api/v1/user/`] endpoint to get user information for the authenticated user.
 +
 [source,terminal]
 ----
@@ -20,8 +20,7 @@ $ curl -X GET "https://quay-server.example.com/api/v1/user/" \
 {"anonymous": false, "username": "quayadmin", "avatar": {"name": "quayadmin", "hash": "6d640d802fe23b93779b987c187a4b7a4d8fbcbd4febe7009bdff58d84498fba", "color": "#f7b6d2", "kind": "user"}, "can_create_repo": true, "is_me": true, "verified": true, "email": "[email protected]", "logins": [], "invoice_email": false, "invoice_email_address": null, "preferred_namespace": false, "tag_expiration_s": 1209600, "prompts": [], "company": null, "family_name": null, "given_name": null, "location": null, "is_free_account": true, "has_password_set": true, "quotas": [{"id": 4, "limit_bytes": 2199023255552, "limits": [{"id": 3, "type": "Reject", "limit_percent": 100}]}], "quota_report": {"quota_bytes": 2280675, "configured_quota": 2199023255552, "running_backfill": "complete", "backfill_status": "complete"}, "organizations": [{"name": "test", "avatar": {"name": "test", "hash": "a15d479002b20f211568fd4419e76686d2b88a4980a5b4c4bc10420776c5f6fe", "color": "#aec7e8", "kind": "org"}, "can_create_repo": true, "public": false, "is_org_admin": true, "preferred_namespace": false}, {"name": "sample", "avatar": {"name": "sample", "hash": "ba560c68f1d26e8c6b911ac9b5d10d513e7e43e576cc2baece1b8a46f36a29a5", "color": "#b5cf6b", "kind": "org"}, "can_create_repo": true, "public": false, "is_org_admin": true, "preferred_namespace": false}], "super_user": true}
 ----
 
-. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/3.13/html-single/red_hat_quay_api_guide/index#getuserinformation[`GET /api/v1/users/{username}`] endpoint to get user information for the specified user.
-
+. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#getuserinformation[`GET /api/v1/users/{username}`] endpoint to get user information for the specified user.
 +
 [source,terminal]
 ----
@@ -36,7 +35,7 @@ $ curl -X GET "https://quay-server.example.com/api/v1/users/example_user" \
 {"anonymous": false, "username": "testuser", "avatar": {"name": "testuser", "hash": "f660ab912ec121d1b1e928a0bb4bc61b15f5ad44d5efdc4e1c92a25e99b8e44a", "color": "#6b6ecf", "kind": "user"}, "super_user": false}
 ----
 
-. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/3.13/html-single/red_hat_quay_api_guide/index#createstar[`POST /api/v1/user/starred`] endpoint to star a repository:
+. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/{producty}/html-single/red_hat_quay_api_guide/index#createstar[`POST /api/v1/user/starred`] endpoint to star a repository:
 +
 [source,terminal]
 ----