Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add GitLab endpoints to the javadoc in the NotesApi #1033

Merged
merged 1 commit into from
Nov 7, 2023
Merged

Add GitLab endpoints to the javadoc in the NotesApi #1033

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions src/main/java/org/gitlab4j/api/NotesApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,8 @@ public Stream<Note> getIssueNotesStream(Object projectIdOrPath, Long issueIid) t
/**
* Get the specified issues's note.
*
* <pre><code>GitLab Endpoint: GET /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
*
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
* @param issueIid the issue IID to get the notes for
* @param noteId the ID of the Note to get
Expand All @@ -145,6 +147,9 @@ public Note getIssueNote(Object projectIdOrPath, Long issueIid, Long noteId) thr

/**
* Create a issues's note.
*
* <pre><code>GitLab Endpoint: POST /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
*
* @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
* @param issueIid the issue IID to create the notes for
* @param body the content of note
Expand All @@ -158,6 +163,8 @@ public Note createIssueNote(Object projectIdOrPath, Long issueIid, String body)
/**
* Create a issues's note.
*
* <pre><code>GitLab Endpoint: POST /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
*
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
* @param issueIid the issue IID to create the notes for
* @param body the content of note
Expand All @@ -171,6 +178,8 @@ public Note createIssueNote(Object projectIdOrPath, Long issueIid, String body,
/**
* Create a issues's note.
*
* <pre><code>GitLab Endpoint: POST /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
*
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
* @param issueIid the issue IID to create the notes for
* @param body the content of note
Expand All @@ -194,6 +203,8 @@ public Note createIssueNote(Object projectIdOrPath, Long issueIid, String body,
/**
* Update the specified issues's note.
*
* <pre><code>GitLab Endpoint: PUT /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
*
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
* @param issueIid the issue IID to update the notes for
* @param noteId the ID of the node to update
Expand All @@ -212,6 +223,8 @@ public Note updateIssueNote(Object projectIdOrPath, Long issueIid, Long noteId,
/**
* Delete the specified issues's note.
*
* <pre><code>GitLab Endpoint: DELETE /projects/:id/issues/:issue_iid/notes/:note_id</code></pre>
*
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
* @param issueIid the issue IID to delete the notes for
* @param noteId the ID of the node to delete
Expand Down Expand Up @@ -378,6 +391,8 @@ public Stream<Note> getMergeRequestNotesStream(Object projectIdOrPath, Long merg
/**
* Get the specified merge request's note.
*
* <pre><code>GitLab Endpoint: GET /projects/:id/merge_requests/:merge_request_iid/notes/:note_id</code></pre>
*
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
* @param mergeRequestIid the merge request IID to get the notes for
* @param noteId the ID of the Note to get
Expand All @@ -393,6 +408,8 @@ public Note getMergeRequestNote(Object projectIdOrPath, Long mergeRequestIid, Lo
/**
* Create a merge request's note.
*
* <pre><code>GitLab Endpoint: POST /projects/:id/merge_requests/:merge_request_iid/notes/:note_id</code></pre>
*
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
* @param mergeRequestIid the merge request IID to create the notes for
* @param body the content of note
Expand All @@ -409,6 +426,8 @@ public Note createMergeRequestNote(Object projectIdOrPath, Long mergeRequestIid,
/**
* Update the specified merge request's note.
*
* <pre><code>GitLab Endpoint: PUT /projects/:id/merge_requests/:merge_request_iid/notes/:note_id</code></pre>
*
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
* @param mergeRequestIid the merge request IID to update the notes for
* @param noteId the ID of the node to update
Expand All @@ -427,6 +446,8 @@ public Note updateMergeRequestNote(Object projectIdOrPath, Long mergeRequestIid,
/**
* Delete the specified merge request's note.
*
* <pre><code>GitLab Endpoint: DELETE /projects/:id/merge_requests/:merge_request_iid/notes/:note_id</code></pre>
*
* @param projectIdOrPath the project in the form of an Long(ID), String(path), or Project instance
* @param mergeRequestIid the merge request IID to delete the notes for
* @param noteId the ID of the node to delete
Expand Down
Loading