Skip to content

Commit f9cb718

Browse files
Asher256@users.noreply.github.comAsher256@users.noreply.github.com
Asher256@users.noreply.github.com
authored and
Asher256@users.noreply.github.com
committed
Documentation for enable/disable deploy key functions
1 parent 61d4cac commit f9cb718

File tree

3 files changed

+26
-2
lines changed

3 files changed

+26
-2
lines changed

docs/gl_objects/deploy_keys.py

+12
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,15 @@
3434
# or
3535
key.delete()
3636
# end delete
37+
38+
# enable
39+
key = gl.project_keys.enable(key_id, project_id=1)
40+
# or
41+
key = project.keys.enable(key_id)
42+
# end enable
43+
44+
# disable
45+
key = gl.project_keys.disable(key_id, project_id=1)
46+
# or
47+
key = project.keys.disable(key_id)
48+
# end disable

docs/gl_objects/deploy_keys.rst

+12
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,15 @@ Delete a deploy key for a project:
5656
.. literalinclude:: deploy_keys.py
5757
:start-after: # delete
5858
:end-before: # end delete
59+
60+
Enable a deploy key for a project:
61+
62+
.. literalinclude:: deploy_keys.py
63+
:start-after: # enable
64+
:end-before: # end enable
65+
66+
Disable a deploy key for a project:
67+
68+
.. literalinclude:: deploy_keys.py
69+
:start-after: # disable
70+
:end-before: # end disable

gitlab/objects.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1249,13 +1249,13 @@ class ProjectKey(GitlabObject):
12491249
requiredUrlAttrs = ['project_id']
12501250
requiredCreateAttrs = ['title', 'key']
12511251

1252-
def enable_deploy_key(self, project_id, key_id):
1252+
def enable(self, key_id, project_id):
12531253
"""Enable a deploy key for a project."""
12541254
url = '/projects/%s/deploy_keys/%s/enable' % (project_id, key_id)
12551255
r = self.gitlab._raw_post(url)
12561256
raise_error_from_response(r, GitlabProjectDeployKeyError, 201)
12571257

1258-
def disable_deploy_key(self, project_id, key_id):
1258+
def disable(self, key_id, project_id):
12591259
"""Disable a deploy key for a project."""
12601260
url = '/projects/%s/deploy_keys/%s/disable' % (project_id, key_id)
12611261
r = self.gitlab._raw_delete(url)

0 commit comments

Comments
 (0)