Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitea089e0

Browse files
author
Gauvain Pocentek
committed
docs: add deploy keys API
1 parent9bd2cb7 commitea089e0

File tree

3 files changed

+95
-0
lines changed

3 files changed

+95
-0
lines changed

‎docs/api-objects.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ API objects manipulation
77
gl_objects/branches
88
gl_objects/builds
99
gl_objects/commits
10+
gl_objects/deploy_keys
1011
gl_objects/groups
1112
gl_objects/issues
1213
gl_objects/namespaces

‎docs/gl_objects/deploy_keys.py

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# global list
2+
keys=gl.keys.list()
3+
# end global list
4+
5+
# global get
6+
key=gl.keys.get(key_id)
7+
# end global key
8+
9+
# list
10+
keys=gl.project_keys.list(project_id=1)
11+
# or
12+
keys=project.keys.list()
13+
# end list
14+
15+
# get
16+
key=gl.project_keys.get(key_id,project_id=1)
17+
# or
18+
key=project.keys.get(key_id)
19+
# end get
20+
21+
# create
22+
key=gl.project_keys.create({'title':'jenkins key',
23+
'key':open('/home/me/.ssh/id_rsa.pub').read()},
24+
project_id=1)
25+
# or
26+
key=project.keys.create({'title':'jenkins key',
27+
'key':open('/home/me/.ssh/id_rsa.pub').read()})
28+
# end create
29+
30+
# delete
31+
key=gl.project_keys.delete(key_id,project_id=1)
32+
# or
33+
key=project.keys.list(key_id)
34+
# or
35+
key.delete()
36+
# end delete

‎docs/gl_objects/deploy_keys.rst

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
###########
2+
Deploy keys
3+
###########
4+
5+
Deploy keys
6+
===========
7+
8+
Use:class:`~gitlab.objects.Key` objects to manipulate deploy keys. The
9+
:attr:`gitlab.Gitlab.keys` manager object provides helper functions.
10+
11+
Examples
12+
--------
13+
14+
List the deploy keys:
15+
16+
..literalinclude::deploy_keys.py
17+
:start-after: # global list
18+
:end-before: # end global list
19+
20+
Get a single deploy key:
21+
22+
..literalinclude::deploy_keys.py
23+
:start-after: # global get
24+
:end-before: # end global get
25+
26+
Deploy keys for projects
27+
========================
28+
29+
Use:class:`~gitlab.objects.ProjectKey` objects to manipulate deploy keys for
30+
projects. The:attr:`gitlab.Gitlab.project_keys` and:attr:`Project.keys
31+
<gitlab.objects.Project.keys>` manager objects provide helper functions.
32+
33+
Examples
34+
--------
35+
36+
List keys for a project:
37+
38+
..literalinclude::deploy_keys.py
39+
:start-after: # list
40+
:end-before: # end list
41+
42+
Get a single deploy key:
43+
44+
..literalinclude::deploy_keys.py
45+
:start-after: # get
46+
:end-before: # end get
47+
48+
Create a deploy key for a project:
49+
50+
..literalinclude::deploy_keys.py
51+
:start-after: # create
52+
:end-before: # end create
53+
54+
Delete a deploy key for a project:
55+
56+
..literalinclude::deploy_keys.py
57+
:start-after: # delete
58+
:end-before: # end delete

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp