docs: notes API

Gauvain Pocentek · Gauvain Pocentek · commit 3e026d2ee62e · 2016-08-09T18:42:57.000+02:00
diff --git a/docs/gl_objects/projects.py b/docs/gl_objects/projects.py
@@ -317,3 +317,47 @@
 # or
 snippet.delete()
 # end snippets delete
+
+# notes list
+i_notes = gl.project_issue_notes.list(project_id=1, issue_id=2)
+mr_notes = gl.project_mergerequest_notes.list(project_id=1, merge_request_id=2)
+s_notes = gl.project_snippet_notes.list(project_id=1, snippet_id=2)
+# or
+i_notes = issue.notes.list()
+mr_notes = mr.notes.list()
+s_notes = snippet.notes.list()
+# end notes list
+
+# notes get
+i_notes = gl.project_issue_notes.get(note_id, project_id=1, issue_id=2)
+mr_notes = gl.project_mergerequest_notes.get(note_id, project_id=1,
+                                             merge_request_id=2)
+s_notes = gl.project_snippet_notes.get(note_id, project_id=1, snippet_id=2)
+# or
+i_note = issue.notes.get(note_id)
+mr_note = mr.notes.get(note_id)
+s_note = snippet.notes.get(note_id)
+# end notes get
+
+# notes create
+i_note = gl.project_issue_notes.create({'body': 'note content'},
+                                       project_id=1, issue_id=2)
+mr_note = gl.project_mergerequest_notes.create({'body': 'note content'}
+                                               project_id=1,
+                                               merge_request_id=2)
+s_note = gl.project_snippet_notes.create({'body': 'note content'},
+                                          project_id=1, snippet_id=2)
+# or
+i_note = issue.notes.create({'body': 'note content'})
+mr_note = mr.notes.create({'body': 'note content'})
+s_note = snippet.notes.create({'body': 'note content'})
+# end notes create
+
+# notes update
+note.body = 'updated note content'
+note.save()
+# end notes update
+
+# notes delete
+note.delete()
+# end notes delete
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
@@ -254,6 +254,48 @@ Delete a snippet:
    :start-after: # snippets delete
    :end-before: # end snippets delete
 
+Notes
+-----
+
+You can manipulate notes (comments) on the following resources:
+
+* :class:`~gitlab.objects.ProjectIssue` with
+  :class:`~gitlab.objects.ProjectIssueNote`
+* :class:`~gitlab.objects.ProjectMergeRequest` with
+  :class:`~gitlab.objects.ProjectMergeRequestNote`
+* :class:`~gitlab.objects.ProjectSnippet` with
+  :class:`~gitlab.objects.ProjectSnippetNote`
+
+List the notes for a resource:
+
+.. literalinclude:: projects.py
+   :start-after: # notes list
+   :end-before: # end notes list
+
+Get a note for a resource:
+
+.. literalinclude:: projects.py
+   :start-after: # notes get
+   :end-before: # end notes get
+
+Create a note for a resource:
+
+.. literalinclude:: projects.py
+   :start-after: # notes create
+   :end-before: # end notes create
+
+Update a note for a resource:
+
+.. literalinclude:: projects.py
+   :start-after: # notes update
+   :end-before: # end notes update
+
+Delete a note for a resource:
+
+.. literalinclude:: projects.py
+   :start-after: # notes delete
+   :end-before: # end notes delete
+
 Events
 ------
 
