From 6dd4ae0d87fd9a30ab9ce36b5127be36929f5692 Mon Sep 17 00:00:00 2001
From: JB Vasseur <jvasseur@gmail.com>
Date: Thu, 11 Oct 2018 19:54:15 +0900
Subject: Support GET /applications and DELETE /applications/:id endpoints
 #52559

---
 doc/api/applications.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 49 insertions(+), 2 deletions(-)

(limited to 'doc')

diff --git a/doc/api/applications.md b/doc/api/applications.md
index 6d244594b71..d74a3cdf5c1 100644
--- a/doc/api/applications.md
+++ b/doc/api/applications.md
@@ -4,12 +4,12 @@
 
 [ce-8160]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8160
 
+Only admin user can use the Applications API.
+
 ## Create a application
 
 Create a application by posting a JSON payload.
 
-User must be admin to do that.
-
 Returns `200` if the request succeeds.
 
 ```
@@ -30,8 +30,55 @@ Example response:
 
 ```json
 {
+    "id":1,
     "application_id": "5832fc6e14300a0d962240a8144466eef4ee93ef0d218477e55f11cf12fc3737",
+    "application_name": "MyApplication",
     "secret": "ee1dd64b6adc89cf7e2c23099301ccc2c61b441064e9324d963c46902a85ec34",
     "callback_url": "http://redirect.uri"
 }
 ```
+
+## List all applications
+
+List all registered applications.
+
+```
+GET /applications
+```
+
+```bash
+curl --request GET --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/applications
+```
+
+Example response:
+
+```json
+[
+    {
+        "id":1,
+        "application_id": "5832fc6e14300a0d962240a8144466eef4ee93ef0d218477e55f11cf12fc3737",
+        "application_name": "MyApplication",
+        "callback_url": "http://redirect.uri"
+    }
+]
+```
+
+> Note: the `secret` value will not be exposed by this API.
+
+## Delete an application
+
+Delete a specific application.
+
+Returns `204` if the request succeeds.
+
+```
+DELETE /applications/:id
+```
+
+Parameters:
+
+- `id` (required) - The id of the application (not the application_id)
+
+```bash
+curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/applications/:id
+```
-- 
cgit v1.2.3