diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2016-08-09 18:42:57 +0200 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2016-08-09 18:42:57 +0200 |
| commit | 3e026d2ee62eba3ad92ff2cdd53db19f5e0e9f6a (patch) | |
| tree | f8be7c9e5aa0465edf4d53b50420a89fcfeb876e /docs/gl_objects/projects.rst | |
| parent | 35b7f750c7e38a39cd4cb27195d9aa4807503b29 (diff) | |
| download | gitlab-3e026d2ee62eba3ad92ff2cdd53db19f5e0e9f6a.tar.gz | |
docs: notes API
Diffstat (limited to 'docs/gl_objects/projects.rst')
| -rw-r--r-- | docs/gl_objects/projects.rst | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst index 947727f..af12025 100644 --- 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 ------ |
