Skip to content

Commit 6561c93

Browse files
authored
Add GitLab endpoints to the javadoc (#1033)
1 parent ab9b98c commit 6561c93

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

src/main/java/org/gitlab4j/api/NotesApi.java

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,8 @@ public Stream<Note> getIssueNotesStream(Object projectIdOrPath, Long issueIid) t
131131
/**
132132
* Get the specified issues's note.
133133
*
134+
* <pre><code>GitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
135+
*
134136
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
135137
* @param issueIid the issue IID to get the notes for
136138
* @param noteId the ID of the Note to get
@@ -145,6 +147,9 @@ public Note getIssueNote(Object projectIdOrPath, Long issueIid, Long noteId) thr
145147

146148
/**
147149
* Create a issues's note.
150+
*
151+
* <pre><code>GitLab Endpoint: POST /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
152+
*
148153
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance @param projectIdOrPath the project ID to create the issues for
149154
* @param issueIid the issue IID to create the notes for
150155
* @param body the content of note
@@ -158,6 +163,8 @@ public Note createIssueNote(Object projectIdOrPath, Long issueIid, String body)
158163
/**
159164
* Create a issues's note.
160165
*
166+
* <pre><code>GitLab Endpoint: POST /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
167+
*
161168
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
162169
* @param issueIid the issue IID to create the notes for
163170
* @param body the content of note
@@ -171,6 +178,8 @@ public Note createIssueNote(Object projectIdOrPath, Long issueIid, String body,
171178
/**
172179
* Create a issues's note.
173180
*
181+
* <pre><code>GitLab Endpoint: POST /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
182+
*
174183
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
175184
* @param issueIid the issue IID to create the notes for
176185
* @param body the content of note
@@ -194,6 +203,8 @@ public Note createIssueNote(Object projectIdOrPath, Long issueIid, String body,
194203
/**
195204
* Update the specified issues's note.
196205
*
206+
* <pre><code>GitLab Endpoint: PUT /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
207+
*
197208
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
198209
* @param issueIid the issue IID to update the notes for
199210
* @param noteId the ID of the node to update
@@ -212,6 +223,8 @@ public Note updateIssueNote(Object projectIdOrPath, Long issueIid, Long noteId,
212223
/**
213224
* Delete the specified issues's note.
214225
*
226+
* <pre><code>GitLab Endpoint: DELETE /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
227+
*
215228
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
216229
* @param issueIid the issue IID to delete the notes for
217230
* @param noteId the ID of the node to delete
@@ -378,6 +391,8 @@ public Stream<Note> getMergeRequestNotesStream(Object projectIdOrPath, Long merg
378391
/**
379392
* Get the specified merge request's note.
380393
*
394+
* <pre><code>GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notes/:note_id</code></pre>
395+
*
381396
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
382397
* @param mergeRequestIid the merge request IID to get the notes for
383398
* @param noteId the ID of the Note to get
@@ -393,6 +408,8 @@ public Note getMergeRequestNote(Object projectIdOrPath, Long mergeRequestIid, Lo
393408
/**
394409
* Create a merge request's note.
395410
*
411+
* <pre><code>GitLab Endpoint: POST /projects/:id/merge_requests/:merge_request_iid/notes/:note_id</code></pre>
412+
*
396413
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
397414
* @param mergeRequestIid the merge request IID to create the notes for
398415
* @param body the content of note
@@ -409,6 +426,8 @@ public Note createMergeRequestNote(Object projectIdOrPath, Long mergeRequestIid,
409426
/**
410427
* Update the specified merge request's note.
411428
*
429+
* <pre><code>GitLab Endpoint: PUT /projects/:id/merge_requests/:merge_request_iid/notes/:note_id</code></pre>
430+
*
412431
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
413432
* @param mergeRequestIid the merge request IID to update the notes for
414433
* @param noteId the ID of the node to update
@@ -427,6 +446,8 @@ public Note updateMergeRequestNote(Object projectIdOrPath, Long mergeRequestIid,
427446
/**
428447
* Delete the specified merge request's note.
429448
*
449+
* <pre><code>GitLab Endpoint: DELETE /projects/:id/merge_requests/:merge_request_iid/notes/:note_id</code></pre>
450+
*
430451
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
431452
* @param mergeRequestIid the merge request IID to delete the notes for
432453
* @param noteId the ID of the node to delete

0 commit comments

Comments
 (0)