Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit3e026d2

Browse files
author
Gauvain Pocentek
committed
docs: notes API
1 parent35b7f75 commit3e026d2

File tree

2 files changed

+86
-0
lines changed

2 files changed

+86
-0
lines changed

‎docs/gl_objects/projects.py

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -317,3 +317,47 @@
317317
# or
318318
snippet.delete()
319319
# end snippets delete
320+
321+
# notes list
322+
i_notes=gl.project_issue_notes.list(project_id=1,issue_id=2)
323+
mr_notes=gl.project_mergerequest_notes.list(project_id=1,merge_request_id=2)
324+
s_notes=gl.project_snippet_notes.list(project_id=1,snippet_id=2)
325+
# or
326+
i_notes=issue.notes.list()
327+
mr_notes=mr.notes.list()
328+
s_notes=snippet.notes.list()
329+
# end notes list
330+
331+
# notes get
332+
i_notes=gl.project_issue_notes.get(note_id,project_id=1,issue_id=2)
333+
mr_notes=gl.project_mergerequest_notes.get(note_id,project_id=1,
334+
merge_request_id=2)
335+
s_notes=gl.project_snippet_notes.get(note_id,project_id=1,snippet_id=2)
336+
# or
337+
i_note=issue.notes.get(note_id)
338+
mr_note=mr.notes.get(note_id)
339+
s_note=snippet.notes.get(note_id)
340+
# end notes get
341+
342+
# notes create
343+
i_note=gl.project_issue_notes.create({'body':'note content'},
344+
project_id=1,issue_id=2)
345+
mr_note=gl.project_mergerequest_notes.create({'body':'note content'}
346+
project_id=1,
347+
merge_request_id=2)
348+
s_note=gl.project_snippet_notes.create({'body':'note content'},
349+
project_id=1,snippet_id=2)
350+
# or
351+
i_note=issue.notes.create({'body':'note content'})
352+
mr_note=mr.notes.create({'body':'note content'})
353+
s_note=snippet.notes.create({'body':'note content'})
354+
# end notes create
355+
356+
# notes update
357+
note.body='updated note content'
358+
note.save()
359+
# end notes update
360+
361+
# notes delete
362+
note.delete()
363+
# end notes delete

‎docs/gl_objects/projects.rst

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,48 @@ Delete a snippet:
254254
:start-after: # snippets delete
255255
:end-before: # end snippets delete
256256

257+
Notes
258+
-----
259+
260+
You can manipulate notes (comments) on the following resources:
261+
262+
*:class:`~gitlab.objects.ProjectIssue` with
263+
:class:`~gitlab.objects.ProjectIssueNote`
264+
*:class:`~gitlab.objects.ProjectMergeRequest` with
265+
:class:`~gitlab.objects.ProjectMergeRequestNote`
266+
*:class:`~gitlab.objects.ProjectSnippet` with
267+
:class:`~gitlab.objects.ProjectSnippetNote`
268+
269+
List the notes for a resource:
270+
271+
..literalinclude::projects.py
272+
:start-after: # notes list
273+
:end-before: # end notes list
274+
275+
Get a note for a resource:
276+
277+
..literalinclude::projects.py
278+
:start-after: # notes get
279+
:end-before: # end notes get
280+
281+
Create a note for a resource:
282+
283+
..literalinclude::projects.py
284+
:start-after: # notes create
285+
:end-before: # end notes create
286+
287+
Update a note for a resource:
288+
289+
..literalinclude::projects.py
290+
:start-after: # notes update
291+
:end-before: # end notes update
292+
293+
Delete a note for a resource:
294+
295+
..literalinclude::projects.py
296+
:start-after: # notes delete
297+
:end-before: # end notes delete
298+
257299
Events
258300
------
259301

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp