blob: fd0788b4ebff219c835532986237b87e95ae7c39 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
.. _project-notes:
#####
Notes
#####
You can manipulate notes (comments) on project issues, merge requests and
snippets.
Reference
---------
* v4 API:
Issues:
+ :class:`gitlab.v4.objects.ProjectIssueNote`
+ :class:`gitlab.v4.objects.ProjectIssueNoteManager`
+ :attr:`gitlab.v4.objects.ProjectIssue.notes`
MergeRequests:
+ :class:`gitlab.v4.objects.ProjectMergeRequestNote`
+ :class:`gitlab.v4.objects.ProjectMergeRequestNoteManager`
+ :attr:`gitlab.v4.objects.ProjectMergeRequest.notes`
Snippets:
+ :class:`gitlab.v4.objects.ProjectSnippetNote`
+ :class:`gitlab.v4.objects.ProjectSnippetNoteManager`
+ :attr:`gitlab.v4.objects.ProjectSnippet.notes`
* v3 API:
Issues:
+ :class:`gitlab.v3.objects.ProjectIssueNote`
+ :class:`gitlab.v3.objects.ProjectIssueNoteManager`
+ :attr:`gitlab.v3.objects.ProjectIssue.notes`
+ :attr:`gitlab.v3.objects.Project.issue_notes`
+ :attr:`gitlab.Gitlab.project_issue_notes`
MergeRequests:
+ :class:`gitlab.v3.objects.ProjectMergeRequestNote`
+ :class:`gitlab.v3.objects.ProjectMergeRequestNoteManager`
+ :attr:`gitlab.v3.objects.ProjectMergeRequest.notes`
+ :attr:`gitlab.v3.objects.Project.mergerequest_notes`
+ :attr:`gitlab.Gitlab.project_mergerequest_notes`
Snippets:
+ :class:`gitlab.v3.objects.ProjectSnippetNote`
+ :class:`gitlab.v3.objects.ProjectSnippetNoteManager`
+ :attr:`gitlab.v3.objects.ProjectSnippet.notes`
+ :attr:`gitlab.v3.objects.Project.snippet_notes`
+ :attr:`gitlab.Gitlab.project_snippet_notes`
* GitLab API: https://docs.gitlab.com/ce/api/notes.html
Examples
--------
List the notes for a resource::
i_notes = issue.notes.list()
mr_notes = mr.notes.list()
s_notes = snippet.notes.list()
Get a note for a resource::
i_note = issue.notes.get(note_id)
mr_note = mr.notes.get(note_id)
s_note = snippet.notes.get(note_id)
Create a note for a resource::
i_note = issue.notes.create({'body': 'note content'})
mr_note = mr.notes.create({'body': 'note content'})
s_note = snippet.notes.create({'body': 'note content'})
Update a note for a resource::
note.body = 'updated note content'
note.save()
Delete a note for a resource::
note.delete()
|
