Unverified Commit 6561c93a authored by Jérémie Bresson's avatar Jérémie Bresson Committed by GitHub
Browse files

Add GitLab endpoints to the javadoc (#1033)

parent ab9b98c1
......@@ -131,6 +131,8 @@ public class NotesApi extends AbstractApi {
/**
* 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
......@@ -145,6 +147,9 @@ public class NotesApi extends AbstractApi {
/**
* 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
......@@ -158,6 +163,8 @@ public class NotesApi extends AbstractApi {
/**
* 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
......@@ -171,6 +178,8 @@ public class NotesApi extends AbstractApi {
/**
* 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
......@@ -194,6 +203,8 @@ public class NotesApi extends AbstractApi {
/**
* 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
......@@ -212,6 +223,8 @@ public class NotesApi extends AbstractApi {
/**
* 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
......@@ -378,6 +391,8 @@ public class NotesApi extends AbstractApi {
/**
* 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
......@@ -393,6 +408,8 @@ public class NotesApi extends AbstractApi {
/**
* 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
......@@ -409,6 +426,8 @@ public class NotesApi extends AbstractApi {
/**
* 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
......@@ -427,6 +446,8 @@ public class NotesApi extends AbstractApi {
/**
* 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
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment