summaryrefslogtreecommitdiff
path: root/doc/api/applications.md
diff options
context:
space:
mode:
authorJB Vasseur <jvasseur@gmail.com>2018-10-11 19:54:15 +0900
committerJB Vasseur <jvasseur@gmail.com>2018-10-11 19:54:15 +0900
commit6dd4ae0d87fd9a30ab9ce36b5127be36929f5692 (patch)
tree284c71c5f9f6b2db8bf10160bc20de98c96bdcd8 /doc/api/applications.md
parent3421f1d124ecf34c620d75488c22fa3fab602721 (diff)
downloadgitlab-ce-6dd4ae0d87fd9a30ab9ce36b5127be36929f5692.tar.gz
Support GET /applications and DELETE /applications/:id endpoints #52559
Diffstat (limited to 'doc/api/applications.md')
-rw-r--r--doc/api/applications.md51
1 files changed, 49 insertions, 2 deletions
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
+```