diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2017-03-17 17:39:20 +0100 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2017-03-17 17:39:20 +0100 |
| commit | a3f2ab138502cf3217d1b97ae7f3cd3a4f8b324f (patch) | |
| tree | 4c367da925afe228d83d61601fdf0af9b3a17b13 /docs/gl_objects | |
| parent | ea0759d71c6678b8ce65791535a9be1675d9cfab (diff) | |
| download | gitlab-a3f2ab138502cf3217d1b97ae7f3cd3a4f8b324f.tar.gz | |
Add DeployKey{,Manager} classes
They are the same as Key and KeyManager but the name makes more sense.
Fixes #212
Diffstat (limited to 'docs/gl_objects')
| -rw-r--r-- | docs/gl_objects/deploy_keys.py | 4 | ||||
| -rw-r--r-- | docs/gl_objects/deploy_keys.rst | 14 |
2 files changed, 11 insertions, 7 deletions
diff --git a/docs/gl_objects/deploy_keys.py b/docs/gl_objects/deploy_keys.py index 5d85055..84da079 100644 --- a/docs/gl_objects/deploy_keys.py +++ b/docs/gl_objects/deploy_keys.py @@ -1,9 +1,9 @@ # global list -keys = gl.keys.list() +keys = gl.deploykeys.list() # end global list # global get -key = gl.keys.get(key_id) +key = gl.deploykeys.get(key_id) # end global get # list diff --git a/docs/gl_objects/deploy_keys.rst b/docs/gl_objects/deploy_keys.rst index 57c1298..28033cb 100644 --- a/docs/gl_objects/deploy_keys.rst +++ b/docs/gl_objects/deploy_keys.rst @@ -5,8 +5,10 @@ Deploy keys Deploy keys =========== -Use :class:`~gitlab.objects.Key` objects to manipulate deploy keys. The -:attr:`gitlab.Gitlab.keys` manager object provides helper functions. +Deploy keys allow read-only access to multiple projects with a single SSH key. + +* Object class: :class:`~gitlab.objects.DeployKey` +* Manager object: :attr:`gitlab.Gitlab.deploykeys` Examples -------- @@ -26,9 +28,11 @@ Get a single deploy key: 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. +Deploy keys can be managed on a per-project basis. + +* Object class: :class:`~gitlab.objects.ProjectKey` +* Manager objects: :attr:`gitlab.Gitlab.project_keys` and :attr:`Project.keys + <gitlab.objects.Project.keys>` Examples -------- |