docs: add deploy keys API

Gauvain Pocentek · Gauvain Pocentek · commit ea089e092439 · 2016-08-06T21:18:02.000+02:00
diff --git a/docs/api-objects.rst b/docs/api-objects.rst
@@ -7,6 +7,7 @@ API objects manipulation
    gl_objects/branches
    gl_objects/builds
    gl_objects/commits
+   gl_objects/deploy_keys
    gl_objects/groups
    gl_objects/issues
    gl_objects/namespaces
diff --git a/docs/gl_objects/deploy_keys.py b/docs/gl_objects/deploy_keys.py
@@ -0,0 +1,36 @@
+# global list
+keys = gl.keys.list()
+# end global list
+
+# global get
+key = gl.keys.get(key_id)
+# end global key
+
+# list
+keys = gl.project_keys.list(project_id=1)
+# or
+keys = project.keys.list()
+# end list
+
+# get
+key = gl.project_keys.get(key_id, project_id=1)
+# or
+key = project.keys.get(key_id)
+# end get
+
+# create
+key = gl.project_keys.create({'title': 'jenkins key',
+                              'key': open('/home/me/.ssh/id_rsa.pub').read()},
+                             project_id=1)
+# or
+key = project.keys.create({'title': 'jenkins key',
+                           'key': open('/home/me/.ssh/id_rsa.pub').read()})
+# end create
+
+# delete
+key = gl.project_keys.delete(key_id, project_id=1)
+# or
+key = project.keys.list(key_id)
+# or
+key.delete()
+# end delete
diff --git a/docs/gl_objects/deploy_keys.rst b/docs/gl_objects/deploy_keys.rst
@@ -0,0 +1,58 @@
+###########
+Deploy keys
+###########
+
+Deploy keys
+===========
+
+Use :class:`~gitlab.objects.Key` objects to manipulate deploy keys. The
+:attr:`gitlab.Gitlab.keys` manager object provides helper functions.
+
+Examples
+--------
+
+List the deploy keys:
+
+.. literalinclude:: deploy_keys.py
+   :start-after: # global list
+   :end-before: # end global list
+
+Get a single deploy key:
+
+.. literalinclude:: deploy_keys.py
+   :start-after: # global get
+   :end-before: # end global get
+
+Deploy keys for projects
+========================
+
+Use :class:`~gitlab.objects.ProjectKey` objects to manipulate deploy keys for
+projects. The :attr:`gitlab.Gitlab.project_keys` and :attr:`Project.keys
+<gitlab.objects.Project.keys>` manager objects provide helper functions.
+
+Examples
+--------
+
+List keys for a project:
+
+.. literalinclude:: deploy_keys.py
+   :start-after: # list
+   :end-before: # end list
+
+Get a single deploy key:
+
+.. literalinclude:: deploy_keys.py
+   :start-after: # get
+   :end-before: # end get
+
+Create a deploy key for a project:
+
+.. literalinclude:: deploy_keys.py
+   :start-after: # create
+   :end-before: # end create
+
+Delete a deploy key for a project:
+
+.. literalinclude:: deploy_keys.py
+   :start-after: # delete
+   :end-before: # end delete
