diff options
author | Asher256@users.noreply.github.com <Asher256> | 2016-10-30 22:50:24 -0400 |
---|---|---|
committer | Asher256@users.noreply.github.com <Asher256> | 2016-10-30 22:50:24 -0400 |
commit | f9cb7184f8907de7f99009b7cce92c5c4eec2107 (patch) | |
tree | 35e3008569d9d79bf18a551c69a1cd42ab7ee496 | |
parent | 61d4cac5c711268ef80e52404c047da2a1f415ca (diff) | |
download | gitlab-f9cb7184f8907de7f99009b7cce92c5c4eec2107.tar.gz |
Documentation for enable/disable deploy key functions
-rw-r--r-- | docs/gl_objects/deploy_keys.py | 12 | ||||
-rw-r--r-- | docs/gl_objects/deploy_keys.rst | 12 | ||||
-rw-r--r-- | gitlab/objects.py | 4 |
3 files changed, 26 insertions, 2 deletions
diff --git a/docs/gl_objects/deploy_keys.py b/docs/gl_objects/deploy_keys.py index 7a69fa3..de79b70 100644 --- a/docs/gl_objects/deploy_keys.py +++ b/docs/gl_objects/deploy_keys.py @@ -34,3 +34,15 @@ key = project.keys.list(key_id) # or key.delete() # end delete + +# enable +key = gl.project_keys.enable(key_id, project_id=1) +# or +key = project.keys.enable(key_id) +# end enable + +# disable +key = gl.project_keys.disable(key_id, project_id=1) +# or +key = project.keys.disable(key_id) +# end disable diff --git a/docs/gl_objects/deploy_keys.rst b/docs/gl_objects/deploy_keys.rst index e67e2c1..57c1298 100644 --- a/docs/gl_objects/deploy_keys.rst +++ b/docs/gl_objects/deploy_keys.rst @@ -56,3 +56,15 @@ Delete a deploy key for a project: .. literalinclude:: deploy_keys.py :start-after: # delete :end-before: # end delete + +Enable a deploy key for a project: + +.. literalinclude:: deploy_keys.py + :start-after: # enable + :end-before: # end enable + +Disable a deploy key for a project: + +.. literalinclude:: deploy_keys.py + :start-after: # disable + :end-before: # end disable diff --git a/gitlab/objects.py b/gitlab/objects.py index 94b7a7c..f3606e8 100644 --- a/gitlab/objects.py +++ b/gitlab/objects.py @@ -1249,13 +1249,13 @@ class ProjectKey(GitlabObject): requiredUrlAttrs = ['project_id'] requiredCreateAttrs = ['title', 'key'] - def enable_deploy_key(self, project_id, key_id): + def enable(self, key_id, project_id): """Enable a deploy key for a project.""" url = '/projects/%s/deploy_keys/%s/enable' % (project_id, key_id) r = self.gitlab._raw_post(url) raise_error_from_response(r, GitlabProjectDeployKeyError, 201) - def disable_deploy_key(self, project_id, key_id): + def disable(self, key_id, project_id): """Disable a deploy key for a project.""" url = '/projects/%s/deploy_keys/%s/disable' % (project_id, key_id) r = self.gitlab._raw_delete(url) |