diff options
| author | Nejc Habjan <hab.nejc@gmail.com> | 2021-11-27 12:36:17 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-27 12:36:17 +0100 |
| commit | 70b9870f929c4db32fd2e1406db2122de9958bfd (patch) | |
| tree | 4ad3181ad0aa0cdba98787a35efedb671077abb1 /docs/gl_objects/notes.rst | |
| parent | 64f2360aecb082baac09cac716f88bd8cc6b443b (diff) | |
| parent | 7f4edb53e9413f401c859701d8c3bac4a40706af (diff) | |
| download | gitlab-70b9870f929c4db32fd2e1406db2122de9958bfd.tar.gz | |
Merge pull request #1712 from StingRayZA/Epicnotes
feat(api): add support for epic notes
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'}) |