summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorMateusz Filipowicz <mateusz.filipowicz@roche.com>2020-03-01 14:24:42 +0100
committerMateusz Filipowicz <mateusz.filipowicz@roche.com>2020-03-01 19:51:36 +0100
commit4e12356d6da58c9ef3d8bf9ae67e8aef8fafac0a (patch)
treedd6704e063182c7748ea493e1ff781f21b40a00c /docs/gl_objects
parentf071390dadc4422c7d3cf77171334a617cfd9908 (diff)
downloadgitlab-4e12356d6da58c9ef3d8bf9ae67e8aef8fafac0a.tar.gz
feat(api): add support for GitLab OAuth Applications API
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/applications.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/gl_objects/applications.rst b/docs/gl_objects/applications.rst
new file mode 100644
index 0000000..146b6e8
--- /dev/null
+++ b/docs/gl_objects/applications.rst
@@ -0,0 +1,31 @@
+############
+Applications
+############
+
+Reference
+---------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.Applications`
+ + :class:`gitlab.v4.objects.ApplicationManager`
+ + :attr:`gitlab.Gitlab.applications`
+
+* GitLab API: https://docs.gitlab.com/ce/api/applications.html
+
+Examples
+--------
+
+List all OAuth applications::
+
+ applications = gl.applications.list()
+
+Create an application::
+
+ gl.applications.create({'name': 'your_app', 'redirect_uri': 'http://application.url', 'scopes': ['api']})
+
+Delete an applications::
+
+ gl.applications.delete(app_id)
+ # or
+ application.delete()