diff options
Diffstat (limited to 'docs/gl_objects/notes.rst')
| -rw-r--r-- | docs/gl_objects/notes.rst | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/gl_objects/notes.rst b/docs/gl_objects/notes.rst index 053c0a0..26d0e5e 100644 --- a/docs/gl_objects/notes.rst +++ b/docs/gl_objects/notes.rst @@ -4,7 +4,7 @@ Notes ##### -You can manipulate notes (comments) on project issues, merge requests and +You can manipulate notes (comments) on group epics, project issues, merge requests and snippets. Reference @@ -12,6 +12,12 @@ Reference * v4 API: + Epics: + + * :class:`gitlab.v4.objects.GroupEpicNote` + * :class:`gitlab.v4.objects.GroupEpicNoteManager` + * :attr:`gitlab.v4.objects.GroupEpic.notes` + Issues: + :class:`gitlab.v4.objects.ProjectIssueNote` @@ -37,18 +43,21 @@ Examples List the notes for a resource:: + e_notes = epic.notes.list() i_notes = issue.notes.list() mr_notes = mr.notes.list() s_notes = snippet.notes.list() Get a note for a resource:: + e_note = epic.notes.get(note_id) 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:: + e_note = epic.notes.create({'body': 'note content'}) i_note = issue.notes.create({'body': 'note content'}) mr_note = mr.notes.create({'body': 'note content'}) s_note = snippet.notes.create({'body': 'note content'}) |