Commit 47a28a36 authored by Greg Messner's avatar Greg Messner
Browse files

Added info on GitLab Endpoints in the Javadocs.

parent 70149ae2
...@@ -73,7 +73,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -73,7 +73,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* gitlab.com has many 100,000's of public projects and it will take hours to fetch all of them. * gitlab.com has many 100,000's of public projects and it will take hours to fetch all of them.
* Instead use {@link #getProjects(int itemsPerPage)} which will return a Pager of Project instances. * Instead use {@link #getProjects(int itemsPerPage)} which will return a Pager of Project instances.
* *
* <pre><code>GET /projects</code></pre> * <pre><code>GitLab Endpoint: GET /projects</code></pre>
* *
* @return a list of projects accessible by the authenticated user * @return a list of projects accessible by the authenticated user
* @throws GitLabApiException if any exception occurs * @throws GitLabApiException if any exception occurs
...@@ -92,7 +92,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -92,7 +92,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of projects accessible by the authenticated user and in the specified page range. * Get a list of projects accessible by the authenticated user and in the specified page range.
* *
* <pre><code>GET /projects</code></pre> * <pre><code>GitLab Endpoint: GET /projects</code></pre>
* *
* @param page the page to get * @param page the page to get
* @param perPage the number of projects per page * @param perPage the number of projects per page
...@@ -107,7 +107,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -107,7 +107,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Pager instance of projects accessible by the authenticated user. * Get a Pager instance of projects accessible by the authenticated user.
* *
* <pre><code>GET /projects</code></pre> * <pre><code>GitLab Endpoint: GET /projects</code></pre>
* *
* @param itemsPerPage the number of Project instances that will be fetched per page * @param itemsPerPage the number of Project instances that will be fetched per page
* @return a Pager instance of projects accessible by the authenticated user * @return a Pager instance of projects accessible by the authenticated user
...@@ -120,7 +120,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -120,7 +120,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Stream of projects accessible by the authenticated user. * Get a Stream of projects accessible by the authenticated user.
* *
* <pre><code>GET /projects</code></pre> * <pre><code>GitLab Endpoint: GET /projects</code></pre>
* *
* @return a Stream of projects accessible by the authenticated user * @return a Stream of projects accessible by the authenticated user
* @throws GitLabApiException if any exception occurs * @throws GitLabApiException if any exception occurs
...@@ -133,7 +133,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -133,7 +133,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* Get a list of projects accessible by the authenticated user and matching the supplied filter parameters. * Get a list of projects accessible by the authenticated user and matching the supplied filter parameters.
* All filter parameters are optional. * All filter parameters are optional.
* *
* <pre><code>GET /projects</code></pre> * <pre><code>GitLab Endpoint: GET /projects</code></pre>
* *
* @param archived limit by archived status * @param archived limit by archived status
* @param visibility limit by visibility public, internal, or private * @param visibility limit by visibility public, internal, or private
...@@ -165,7 +165,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -165,7 +165,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* Get a list of projects accessible by the authenticated user and matching the supplied filter parameters. * Get a list of projects accessible by the authenticated user and matching the supplied filter parameters.
* All filter parameters are optional. * All filter parameters are optional.
* *
* <pre><code>GET /projects</code></pre> * <pre><code>GitLab Endpoint: GET /projects</code></pre>
* *
* @param archived limit by archived status * @param archived limit by archived status
* @param visibility limit by visibility public, internal, or private * @param visibility limit by visibility public, internal, or private
...@@ -193,7 +193,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -193,7 +193,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* Get a list of projects accessible by the authenticated user and matching the supplied filter parameters. * Get a list of projects accessible by the authenticated user and matching the supplied filter parameters.
* All filter parameters are optional. * All filter parameters are optional.
* *
* <pre><code>GET /projects</code></pre> * <pre><code>GitLab Endpoint: GET /projects</code></pre>
* *
* @param archived limit by archived status * @param archived limit by archived status
* @param visibility limit by visibility public, internal, or private * @param visibility limit by visibility public, internal, or private
...@@ -237,7 +237,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -237,7 +237,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* Get a Pager of projects accessible by the authenticated user and matching the supplied filter parameters. * Get a Pager of projects accessible by the authenticated user and matching the supplied filter parameters.
* All filter parameters are optional. * All filter parameters are optional.
* *
* <pre><code>GET /projects</code></pre> * <pre><code>GitLab Endpoint: GET /projects</code></pre>
* *
* @param archived limit by archived status * @param archived limit by archived status
* @param visibility limit by visibility public, internal, or private * @param visibility limit by visibility public, internal, or private
...@@ -276,7 +276,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -276,7 +276,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of projects accessible by the authenticated user that match the provided search string. * Get a list of projects accessible by the authenticated user that match the provided search string.
* *
* <pre><code>GET /projects?search=search</code></pre> * <pre><code>GitLab Endpoint: GET /projects?search=search</code></pre>
* *
* @param search the project name search criteria * @param search the project name search criteria
* @return a list of projects accessible by the authenticated user that match the provided search string * @return a list of projects accessible by the authenticated user that match the provided search string
...@@ -289,7 +289,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -289,7 +289,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of projects accessible by the authenticated user that match the provided search string. * Get a list of projects accessible by the authenticated user that match the provided search string.
* *
* <pre><code>GET /projects?search=search</code></pre> * <pre><code>GitLab Endpoint: GET /projects?search=search</code></pre>
* *
* @param search the project name search criteria * @param search the project name search criteria
* @param page the page to get * @param page the page to get
...@@ -306,7 +306,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -306,7 +306,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Pager of projects accessible by the authenticated user that match the provided search string. * Get a Pager of projects accessible by the authenticated user that match the provided search string.
* *
* <pre><code>GET /projects?search=search</code></pre> * <pre><code>GitLab Endpoint: GET /projects?search=search</code></pre>
* *
* @param search the project name search criteria * @param search the project name search criteria
* @param itemsPerPage the number of Project instances that will be fetched per page * @param itemsPerPage the number of Project instances that will be fetched per page
...@@ -321,7 +321,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -321,7 +321,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Stream of projects accessible by the authenticated user that match the provided search string. * Get a Stream of projects accessible by the authenticated user that match the provided search string.
* *
* <pre><code>GET /projects?search=search</code></pre> * <pre><code>GitLab Endpoint: GET /projects?search=search</code></pre>
* *
* @param search the project name search criteria * @param search the project name search criteria
* @return a Stream of projects accessible by the authenticated user that match the provided search string * @return a Stream of projects accessible by the authenticated user that match the provided search string
...@@ -334,7 +334,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -334,7 +334,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of projects that the authenticated user is a member of. * Get a list of projects that the authenticated user is a member of.
* *
* <pre><code>GET /projects?membership=true</code></pre> * <pre><code>GitLab Endpoint: GET /projects?membership=true</code></pre>
* *
* @return a list of projects that the authenticated user is a member of * @return a list of projects that the authenticated user is a member of
* @throws GitLabApiException if any exception occurs * @throws GitLabApiException if any exception occurs
...@@ -346,7 +346,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -346,7 +346,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of projects that the authenticated user is a member of in the specified page range. * Get a list of projects that the authenticated user is a member of in the specified page range.
* *
* <pre><code>GET /projects?membership=true</code></pre> * <pre><code>GitLab Endpoint: GET /projects?membership=true</code></pre>
* *
* @param page the page to get * @param page the page to get
* @param perPage the number of projects per page * @param perPage the number of projects per page
...@@ -362,7 +362,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -362,7 +362,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Pager of projects that the authenticated user is a member of. * Get a Pager of projects that the authenticated user is a member of.
* *
* <pre><code>GET /projects?membership=true</code></pre> * <pre><code>GitLab Endpoint: GET /projects?membership=true</code></pre>
* *
* @param itemsPerPage the number of Project instances that will be fetched per page * @param itemsPerPage the number of Project instances that will be fetched per page
* @return a Pager o Project instances that the authenticated user is a member of * @return a Pager o Project instances that the authenticated user is a member of
...@@ -376,7 +376,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -376,7 +376,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Stream of projects that the authenticated user is a member of. * Get a Stream of projects that the authenticated user is a member of.
* *
* <pre><code>GET /projects?membership=true</code></pre> * <pre><code>GitLab Endpoint: GET /projects?membership=true</code></pre>
* *
* @return a list of projects that the authenticated user is a member of * @return a list of projects that the authenticated user is a member of
* @throws GitLabApiException if any exception occurs * @throws GitLabApiException if any exception occurs
...@@ -388,7 +388,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -388,7 +388,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of projects owned by the authenticated user. * Get a list of projects owned by the authenticated user.
* *
* <pre><code>GET /projects?owned=true</code></pre> * <pre><code>GitLab Endpoint: GET /projects?owned=true</code></pre>
* *
* @return a list of projects owned by the authenticated user * @return a list of projects owned by the authenticated user
* @throws GitLabApiException if any exception occurs * @throws GitLabApiException if any exception occurs
...@@ -400,7 +400,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -400,7 +400,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of projects owned by the authenticated user in the specified page range. * Get a list of projects owned by the authenticated user in the specified page range.
* *
* <pre><code>GET /projects?owned=true</code></pre> * <pre><code>GitLab Endpoint: GET /projects?owned=true</code></pre>
* *
* @param page the page to get * @param page the page to get
* @param perPage the number of projects per page * @param perPage the number of projects per page
...@@ -416,7 +416,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -416,7 +416,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Pager of projects owned by the authenticated user. * Get a Pager of projects owned by the authenticated user.
* *
* <pre><code>GET /projects?owned=true</code></pre> * <pre><code>GitLab Endpoint: GET /projects?owned=true</code></pre>
* *
* @param itemsPerPage the number of Project instances that will be fetched per page * @param itemsPerPage the number of Project instances that will be fetched per page
* @return a list of projects owned by the authenticated user * @return a list of projects owned by the authenticated user
...@@ -430,7 +430,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -430,7 +430,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Stream of projects owned by the authenticated user. * Get a Stream of projects owned by the authenticated user.
* *
* <pre><code>GET /projects?owned=true</code></pre> * <pre><code>GitLab Endpoint: GET /projects?owned=true</code></pre>
* *
* @return a Stream of projects owned by the authenticated user * @return a Stream of projects owned by the authenticated user
* @throws GitLabApiException if any exception occurs * @throws GitLabApiException if any exception occurs
...@@ -442,7 +442,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -442,7 +442,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of projects starred by the authenticated user. * Get a list of projects starred by the authenticated user.
* *
* <pre><code>GET /projects?starred=true</code></pre> * <pre><code>GitLab Endpoint: GET /projects?starred=true</code></pre>
* *
* @return a list of projects starred by the authenticated user * @return a list of projects starred by the authenticated user
* @throws GitLabApiException if any exception occurs * @throws GitLabApiException if any exception occurs
...@@ -454,7 +454,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -454,7 +454,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of projects starred by the authenticated user in the specified page range. * Get a list of projects starred by the authenticated user in the specified page range.
* *
* <pre><code>GET /projects?starred=true</code></pre> * <pre><code>GitLab Endpoint: GET /projects?starred=true</code></pre>
* *
* @param page the page to get * @param page the page to get
* @param perPage the number of projects per page * @param perPage the number of projects per page
...@@ -470,7 +470,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -470,7 +470,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Pager of projects starred by the authenticated user. * Get a Pager of projects starred by the authenticated user.
* *
* <pre><code>GET /projects?starred=true</code></pre> * <pre><code>GitLab Endpoint: GET /projects?starred=true</code></pre>
* *
* @param itemsPerPage the number of Project instances that will be fetched per page * @param itemsPerPage the number of Project instances that will be fetched per page
* @return a Pager of projects starred by the authenticated user * @return a Pager of projects starred by the authenticated user
...@@ -484,7 +484,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -484,7 +484,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Stream of projects starred by the authenticated user. * Get a Stream of projects starred by the authenticated user.
* *
* <pre><code>GET /projects?starred=true</code></pre> * <pre><code>GitLab Endpoint: GET /projects?starred=true</code></pre>
* *
* @return a Stream of projects starred by the authenticated user * @return a Stream of projects starred by the authenticated user
* @throws GitLabApiException if any exception occurs * @throws GitLabApiException if any exception occurs
...@@ -496,7 +496,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -496,7 +496,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of all visible projects across GitLab for the authenticated user using the provided filter. * Get a list of all visible projects across GitLab for the authenticated user using the provided filter.
* *
* <pre><code>GET /projects</code></pre> * <pre><code>GitLab Endpoint: GET /projects</code></pre>
* *
* @param filter the ProjectFilter instance holding the filter values for the query * @param filter the ProjectFilter instance holding the filter values for the query
* @return a list of all visible projects across GitLab for the authenticated use * @return a list of all visible projects across GitLab for the authenticated use
...@@ -510,7 +510,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -510,7 +510,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* Get a list of all visible projects across GitLab for the authenticated user in the specified page range * Get a list of all visible projects across GitLab for the authenticated user in the specified page range
* using the provided filter. * using the provided filter.
* *
* <pre><code>GET /projects</code></pre> * <pre><code>GitLab Endpoint: GET /projects</code></pre>
* *
* @param filter the ProjectFilter instance holding the filter values for the query * @param filter the ProjectFilter instance holding the filter values for the query
* @param page the page to get * @param page the page to get
...@@ -527,7 +527,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -527,7 +527,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Pager of all visible projects across GitLab for the authenticated user using the provided filter. * Get a Pager of all visible projects across GitLab for the authenticated user using the provided filter.
* *
* <pre><code>GET /projects</code></pre> * <pre><code>GitLab Endpoint: GET /projects</code></pre>
* *
* @param filter the ProjectFilter instance holding the filter values for the query * @param filter the ProjectFilter instance holding the filter values for the query
* @param itemsPerPage the number of Project instances that will be fetched per page * @param itemsPerPage the number of Project instances that will be fetched per page
...@@ -542,7 +542,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -542,7 +542,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Stream of all visible projects across GitLab for the authenticated user using the provided filter. * Get a Stream of all visible projects across GitLab for the authenticated user using the provided filter.
* *
* <pre><code>GET /projects</code></pre> * <pre><code>GitLab Endpoint: GET /projects</code></pre>
* *
* @param filter the ProjectFilter instance holding the filter values for the query * @param filter the ProjectFilter instance holding the filter values for the query
* @return a Stream of all visible projects across GitLab for the authenticated use * @return a Stream of all visible projects across GitLab for the authenticated use
...@@ -555,7 +555,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -555,7 +555,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of visible projects owned by the given user. * Get a list of visible projects owned by the given user.
* *
* <pre><code>GET /users/:user_id/projects</code></pre> * <pre><code>GitLab Endpoint: GET /users/:user_id/projects</code></pre>
* *
* @param userIdOrUsername the user ID, username of the user, or a User instance holding the user ID or username * @param userIdOrUsername the user ID, username of the user, or a User instance holding the user ID or username
* @param filter the ProjectFilter instance holding the filter values for the query * @param filter the ProjectFilter instance holding the filter values for the query
...@@ -569,7 +569,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -569,7 +569,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of visible projects owned by the given user in the specified page range. * Get a list of visible projects owned by the given user in the specified page range.
* *
* <pre><code>GET /users/:user_id/projects</code></pre> * <pre><code>GitLab Endpoint: GET /users/:user_id/projects</code></pre>
* *
* @param userIdOrUsername the user ID, username of the user, or a User instance holding the user ID or username * @param userIdOrUsername the user ID, username of the user, or a User instance holding the user ID or username
* @param filter the ProjectFilter instance holding the filter values for the query * @param filter the ProjectFilter instance holding the filter values for the query
...@@ -588,7 +588,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -588,7 +588,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Pager of visible projects owned by the given user. * Get a Pager of visible projects owned by the given user.
* *
* <pre><code>GET /users/:user_id/projects</code></pre> * <pre><code>GitLab Endpoint: GET /users/:user_id/projects</code></pre>
* *
* @param userIdOrUsername the user ID, username of the user, or a User instance holding the user ID or username * @param userIdOrUsername the user ID, username of the user, or a User instance holding the user ID or username
* @param filter the ProjectFilter instance holding the filter values for the query * @param filter the ProjectFilter instance holding the filter values for the query
...@@ -605,7 +605,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -605,7 +605,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Stream of visible projects owned by the given user. * Get a Stream of visible projects owned by the given user.
* *
* <pre><code>GET /users/:user_id/projects</code></pre> * <pre><code>GitLab Endpoint: GET /users/:user_id/projects</code></pre>
* *
* @param userIdOrUsername the user ID, username of the user, or a User instance holding the user ID or username * @param userIdOrUsername the user ID, username of the user, or a User instance holding the user ID or username
* @param filter the ProjectFilter instance holding the filter values for the query * @param filter the ProjectFilter instance holding the filter values for the query
...@@ -619,7 +619,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -619,7 +619,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a specific project, which is owned by the authentication user. * Get a specific project, which is owned by the authentication user.
* *
* <pre><code>GET /projects/:id</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return the specified project * @return the specified project
...@@ -633,7 +633,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -633,7 +633,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get an Optional instance with the value for the specific project, which is owned by the authentication user. * Get an Optional instance with the value for the specific project, which is owned by the authentication user.
* *
* <pre><code>GET /projects/:id</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return an Optional instance with the specified project as a value * @return an Optional instance with the specified project as a value
...@@ -649,7 +649,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -649,7 +649,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a specific project, which is owned by the authentication user. * Get a specific project, which is owned by the authentication user.
* *
* <pre><code>GET /projects/:id</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param includeStatistics include project statistics * @param includeStatistics include project statistics
...@@ -665,7 +665,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -665,7 +665,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get an Optional instance with the value for the specific project, which is owned by the authentication user. * Get an Optional instance with the value for the specific project, which is owned by the authentication user.
* *
* <pre><code>GET /projects/:id</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param includeStatistics include project statistics * @param includeStatistics include project statistics
...@@ -682,7 +682,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -682,7 +682,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a specific project, which is owned by the authentication user. * Get a specific project, which is owned by the authentication user.
* *
* <pre><code>GET /projects/:id</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id</code></pre>
* *
* @param namespace the name of the project namespace or group * @param namespace the name of the project namespace or group
* @param project the name of the project to get * @param project the name of the project to get
...@@ -713,7 +713,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -713,7 +713,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get an Optional instance with the value for the specific project, which is owned by the authentication user. * Get an Optional instance with the value for the specific project, which is owned by the authentication user.
* *
* <pre><code>GET /projects/:id</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id</code></pre>
* *
* @param namespace the name of the project namespace or group * @param namespace the name of the project namespace or group
* @param project the name of the project * @param project the name of the project
...@@ -730,7 +730,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -730,7 +730,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a specific project, which is owned by the authentication user. * Get a specific project, which is owned by the authentication user.
* *
* <pre><code>GET /projects/:id</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id</code></pre>
* *
* @param namespace the name of the project namespace or group * @param namespace the name of the project namespace or group
* @param project the name of the project to get * @param project the name of the project to get
...@@ -763,7 +763,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -763,7 +763,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get an Optional instance with the value for the specific project, which is owned by the authentication user. * Get an Optional instance with the value for the specific project, which is owned by the authentication user.
* *
* <pre><code>GET /projects/:id</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id</code></pre>
* *
* @param namespace the name of the project namespace or group * @param namespace the name of the project namespace or group
* @param project the name of the project * @param project the name of the project
...@@ -1178,7 +1178,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1178,7 +1178,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Removes project with all resources(issues, merge requests etc). * Removes project with all resources(issues, merge requests etc).
* *
* <pre><code>DELETE /projects/:id</code></pre> * <pre><code>GitLab Endpoint: DELETE /projects/:id</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @throws GitLabApiException if any exception occurs * @throws GitLabApiException if any exception occurs
...@@ -1193,7 +1193,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1193,7 +1193,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* The forking operation for a project is asynchronous and is completed in a background job. * The forking operation for a project is asynchronous and is completed in a background job.
* The request will return immediately. * The request will return immediately.
* *
* <pre><code>POST /projects/:id/fork</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/fork</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param namespace path of the namespace that the project will be forked to * @param namespace path of the namespace that the project will be forked to
...@@ -1212,7 +1212,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1212,7 +1212,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* The forking operation for a project is asynchronous and is completed in a background job. * The forking operation for a project is asynchronous and is completed in a background job.
* The request will return immediately. * The request will return immediately.
* *
* <pre><code>POST /projects/:id/fork</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/fork</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param namespaceId ID of the namespace that the project will be forked to * @param namespaceId ID of the namespace that the project will be forked to
...@@ -1229,7 +1229,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1229,7 +1229,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Create a forked from/to relation between existing projects. * Create a forked from/to relation between existing projects.
* *
* <pre><code>POST /projects/:id/fork/:forkFromId</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/fork/:forkFromId</code></pre>
* *
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
...@@ -1246,7 +1246,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1246,7 +1246,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Delete an existing forked from relationship. * Delete an existing forked from relationship.
* *
* <pre><code>DELETE /projects/:id/fork</code></pre> * <pre><code>GitLab Endpoint: DELETE /projects/:id/fork</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @throws GitLabApiException if any exception occurs * @throws GitLabApiException if any exception occurs
...@@ -1259,7 +1259,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1259,7 +1259,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of project team members. * Get a list of project team members.
* *
* <pre><code>GET /projects/:id/members</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/members</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return the members belonging to the specified project * @return the members belonging to the specified project
...@@ -1272,7 +1272,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1272,7 +1272,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of project team members in the specified page range. * Get a list of project team members in the specified page range.
* *
* <pre><code>GET /projects/:id/members</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/members</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param page the page to get * @param page the page to get
...@@ -1288,7 +1288,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1288,7 +1288,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Pager of project team members. * Get a Pager of project team members.
* *
* <pre><code>GET /projects/:id/members</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/members</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param itemsPerPage the number of Project instances that will be fetched per page * @param itemsPerPage the number of Project instances that will be fetched per page
...@@ -1302,7 +1302,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1302,7 +1302,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Stream of project team members. * Get a Stream of project team members.
* *
* <pre><code>GET /projects/:id/members</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/members</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return a Stream of the members belonging to the specified project * @return a Stream of the members belonging to the specified project
...@@ -1318,7 +1318,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1318,7 +1318,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* times the same user (with different member attributes) when the user is * times the same user (with different member attributes) when the user is
* a member of the project/group and of one or more ancestor group. * a member of the project/group and of one or more ancestor group.
* *
* <pre><code>GET /projects/:id/members/all</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/members/all</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return the project members viewable by the authenticated user, including inherited members through ancestor groups * @return the project members viewable by the authenticated user, including inherited members through ancestor groups
...@@ -1334,7 +1334,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1334,7 +1334,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* times the same user (with different member attributes) when the user is * times the same user (with different member attributes) when the user is
* a member of the project/group and of one or more ancestor group. * a member of the project/group and of one or more ancestor group.
* *
* <pre><code>GET /projects/:id/members</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/members</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param page the page to get * @param page the page to get
...@@ -1354,7 +1354,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1354,7 +1354,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* times the same user (with different member attributes) when the user is * times the same user (with different member attributes) when the user is
* a member of the project/group and of one or more ancestor group. * a member of the project/group and of one or more ancestor group.
* *
* <pre><code>GET /projects/:id/members/all</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/members/all</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param itemsPerPage the number of Project instances that will be fetched per page * @param itemsPerPage the number of Project instances that will be fetched per page
...@@ -1373,7 +1373,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1373,7 +1373,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* times the same user (with different member attributes) when the user is * times the same user (with different member attributes) when the user is
* a member of the project/group and of one or more ancestor group. * a member of the project/group and of one or more ancestor group.
* *
* <pre><code>GET /projects/:id/members/all</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/members/all</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return a Stream of the project members viewable by the authenticated user, * @return a Stream of the project members viewable by the authenticated user,
...@@ -1387,7 +1387,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1387,7 +1387,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Gets a project team member. * Gets a project team member.
* *
* <pre><code>GET /projects/:id/members/:user_id</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/members/:user_id</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param userId the user ID of the member * @param userId the user ID of the member
...@@ -1402,7 +1402,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1402,7 +1402,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Gets a project team member. * Gets a project team member.
* *
* <pre><code>GET /projects/:id/members/:user_id</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/members/:user_id</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param userId the user ID of the member * @param userId the user ID of the member
...@@ -1421,7 +1421,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1421,7 +1421,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* with the same parameters. Adding team membership to a user that is already a member does not * with the same parameters. Adding team membership to a user that is already a member does not
* affect the existing membership. * affect the existing membership.
* *
* <pre><code>POST /projects/:id/members</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/members</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param userId the user ID of the member to add, required * @param userId the user ID of the member to add, required
...@@ -1438,7 +1438,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1438,7 +1438,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* with the same parameters. Adding team membership to a user that is already a member does not * with the same parameters. Adding team membership to a user that is already a member does not
* affect the existing membership. * affect the existing membership.
* *
* <pre><code>POST /projects/:id/members</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/members</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param userId the user ID of the member to add, required * @param userId the user ID of the member to add, required
...@@ -1455,7 +1455,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1455,7 +1455,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* with the same parameters. Adding team membership to a user that is already a member does not * with the same parameters. Adding team membership to a user that is already a member does not
* affect the existing membership. * affect the existing membership.
* *
* <pre><code>POST /projects/:id/members</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/members</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param userId the user ID of the member to add * @param userId the user ID of the member to add
...@@ -1473,7 +1473,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1473,7 +1473,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* with the same parameters. Adding team membership to a user that is already a member does not * with the same parameters. Adding team membership to a user that is already a member does not
* affect the existing membership. * affect the existing membership.
* *
* <pre><code>POST /projects/:id/members</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/members</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param userId the user ID of the member to add * @param userId the user ID of the member to add
...@@ -1494,7 +1494,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1494,7 +1494,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Updates a member of a project. * Updates a member of a project.
* *
* <pre><code>PUT /projects/:projectId/members/:userId</code></pre> * <pre><code>GitLab Endpoint: PUT /projects/:projectId/members/:userId</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param userId the user ID of the member to update, required * @param userId the user ID of the member to update, required
...@@ -1509,7 +1509,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1509,7 +1509,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Updates a member of a project. * Updates a member of a project.
* *
* <pre><code>PUT /projects/:projectId/members/:userId</code></pre> * <pre><code>GitLab Endpoint: PUT /projects/:projectId/members/:userId</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param userId the user ID of the member to update, required * @param userId the user ID of the member to update, required
...@@ -1524,7 +1524,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1524,7 +1524,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Updates a member of a project. * Updates a member of a project.
* *
* <pre><code>PUT /projects/:projectId/members/:userId</code></pre> * <pre><code>GitLab Endpoint: PUT /projects/:projectId/members/:userId</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param userId the user ID of the member to update, required * @param userId the user ID of the member to update, required
...@@ -1540,7 +1540,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1540,7 +1540,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Updates a member of a project. * Updates a member of a project.
* *
* <pre><code>PUT /projects/:projectId/members/:userId</code></pre> * <pre><code>GitLab Endpoint: PUT /projects/:projectId/members/:userId</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param userId the user ID of the member to update, required * @param userId the user ID of the member to update, required
...@@ -1560,7 +1560,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1560,7 +1560,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Removes user from project team. * Removes user from project team.
* *
* <pre><code>DELETE /projects/:id/members/:user_id</code></pre> * <pre><code>GitLab Endpoint: DELETE /projects/:id/members/:user_id</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param userId the user ID of the member to remove * @param userId the user ID of the member to remove
...@@ -1574,7 +1574,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1574,7 +1574,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of project users. This list includes all project members and all users assigned to project parent groups. * Get a list of project users. This list includes all project members and all users assigned to project parent groups.
* *
* <pre><code>GET /projects/:id/users</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/users</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @return the users belonging to the specified project and its parent groups * @return the users belonging to the specified project and its parent groups
...@@ -1587,7 +1587,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1587,7 +1587,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Pager of project users. This Pager includes all project members and all users assigned to project parent groups. * Get a Pager of project users. This Pager includes all project members and all users assigned to project parent groups.
* *
* <pre><code>GET /projects/:id/users</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/users</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param itemsPerPage the number of Project instances that will be fetched per page * @param itemsPerPage the number of Project instances that will be fetched per page
...@@ -1601,7 +1601,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1601,7 +1601,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Stream of project users. This Stream includes all project members and all users assigned to project parent groups. * Get a Stream of project users. This Stream includes all project members and all users assigned to project parent groups.
* *
* <pre><code>GET /projects/:id/users</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/users</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @return a Stream of the users belonging to the specified project and its parent groups * @return a Stream of the users belonging to the specified project and its parent groups
...@@ -1615,7 +1615,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1615,7 +1615,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* Get a list of project users matching the specified search string. This list * Get a list of project users matching the specified search string. This list
* includes all project members and all users assigned to project parent groups. * includes all project members and all users assigned to project parent groups.
* *
* <pre><code>GET /projects/:id/users</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/users</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param search the string to match specific users * @param search the string to match specific users
...@@ -1630,7 +1630,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1630,7 +1630,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* Get a Pager of project users matching the specified search string. This Pager includes * Get a Pager of project users matching the specified search string. This Pager includes
* all project members and all users assigned to project parent groups. * all project members and all users assigned to project parent groups.
* *
* <pre><code>GET /projects/:id/users</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/users</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param search the string to match specific users * @param search the string to match specific users
...@@ -1648,7 +1648,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1648,7 +1648,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* Get a Stream of project users matching the specified search string. This Stream * Get a Stream of project users matching the specified search string. This Stream
* includes all project members and all users assigned to project parent groups. * includes all project members and all users assigned to project parent groups.
* *
* <pre><code>GET /projects/:id/users</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/users</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param search the string to match specific users * @param search the string to match specific users
...@@ -1662,7 +1662,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1662,7 +1662,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get the project events for specific project. Sorted from newest to latest. * Get the project events for specific project. Sorted from newest to latest.
* *
* <pre><code>GET /projects/:id/events</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/events</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @return the project events for the specified project * @return the project events for the specified project
...@@ -1675,7 +1675,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1675,7 +1675,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get the project events for specific project. Sorted from newest to latest in the specified page range. * Get the project events for specific project. Sorted from newest to latest in the specified page range.
* *
* <pre><code>GET /projects/:id/events</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/events</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param page the page to get * @param page the page to get
...@@ -1691,7 +1691,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1691,7 +1691,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Pager of project events for specific project. Sorted from newest to latest. * Get a Pager of project events for specific project. Sorted from newest to latest.
* *
* <pre><code>GET /projects/:id/events</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/events</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param itemsPerPage the number of Project instances that will be fetched per page * @param itemsPerPage the number of Project instances that will be fetched per page
...@@ -1705,7 +1705,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1705,7 +1705,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Stream of the project events for specific project. Sorted from newest to latest. * Get a Stream of the project events for specific project. Sorted from newest to latest.
* *
* <pre><code>GET /projects/:id/events</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/events</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @return a Stream of the project events for the specified project * @return a Stream of the project events for the specified project
...@@ -1718,7 +1718,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1718,7 +1718,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of the project hooks for the specified project. * Get a list of the project hooks for the specified project.
* *
* <pre><code>GET /projects/:id/hooks</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/hooks</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @return a list of project hooks for the specified project * @return a list of project hooks for the specified project
...@@ -1731,7 +1731,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1731,7 +1731,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get list of project hooks in the specified page range. * Get list of project hooks in the specified page range.
* *
* <pre><code>GET /projects/:id/hooks</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/hooks</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param page the page to get * @param page the page to get
...@@ -1747,7 +1747,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1747,7 +1747,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get Pager of project hooks. * Get Pager of project hooks.
* *
* <pre><code>GET /projects/:id/hooks</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/hooks</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param itemsPerPage the number of Project instances that will be fetched per page * @param itemsPerPage the number of Project instances that will be fetched per page
...@@ -1761,7 +1761,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1761,7 +1761,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Stream of the project hooks for the specified project. * Get a Stream of the project hooks for the specified project.
* *
* <pre><code>GET /projects/:id/hooks</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/hooks</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @return a Stream of project hooks for the specified project * @return a Stream of project hooks for the specified project
...@@ -1774,7 +1774,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1774,7 +1774,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a specific hook for project. * Get a specific hook for project.
* *
* <pre><code>GET /projects/:id/hooks/:hook_id</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/hooks/:hook_id</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param hookId the ID of the hook to get * @param hookId the ID of the hook to get
...@@ -1789,7 +1789,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1789,7 +1789,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a specific hook for project as an Optional instance. * Get a specific hook for project as an Optional instance.
* *
* <pre><code>GET /projects/:id/hooks/:hook_id</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/hooks/:hook_id</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param hookId the ID of the hook to get * @param hookId the ID of the hook to get
...@@ -1806,7 +1806,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1806,7 +1806,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Adds a hook to project. * Adds a hook to project.
* *
* <pre><code>POST /projects/:id/hooks</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/hooks</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param url the callback URL for the hook * @param url the callback URL for the hook
...@@ -1842,7 +1842,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1842,7 +1842,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Adds a hook to project. * Adds a hook to project.
* *
* <pre><code>POST /projects/:id/hooks</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/hooks</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param url the callback URL for the hook * @param url the callback URL for the hook
...@@ -1868,7 +1868,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1868,7 +1868,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Deletes a hook from the project. * Deletes a hook from the project.
* *
* <pre><code>DELETE /projects/:id/hooks/:hook_id</code></pre> * <pre><code>GitLab Endpoint: DELETE /projects/:id/hooks/:hook_id</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param hookId the project hook ID to delete * @param hookId the project hook ID to delete
...@@ -1882,7 +1882,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1882,7 +1882,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Deletes a hook from the project. * Deletes a hook from the project.
* *
* <pre><code>DELETE /projects/:id/hooks/:hook_id</code></pre> * <pre><code>GitLab Endpoint: DELETE /projects/:id/hooks/:hook_id</code></pre>
* *
* @param hook the ProjectHook instance to remove * @param hook the ProjectHook instance to remove
* @throws GitLabApiException if any exception occurs * @throws GitLabApiException if any exception occurs
...@@ -1894,7 +1894,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1894,7 +1894,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Modifies a hook for project. * Modifies a hook for project.
* *
* <pre><code>PUT /projects/:id/hooks/:hook_id</code></pre> * <pre><code>GitLab Endpoint: PUT /projects/:id/hooks/:hook_id</code></pre>
* *
* @param hook the ProjectHook instance that contains the project hook info to modify * @param hook the ProjectHook instance that contains the project hook info to modify
* @return the modified project hook * @return the modified project hook
...@@ -1922,7 +1922,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1922,7 +1922,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of the project's issues. * Get a list of the project's issues.
* *
* <pre><code>GET /projects/:id/issues</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/issues</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @return a list of project's issues * @return a list of project's issues
...@@ -1937,7 +1937,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1937,7 +1937,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of project's issues using the specified page and per page settings. * Get a list of project's issues using the specified page and per page settings.
* *
* <pre><code>GET /projects/:id/issues</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/issues</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param page the page to get * @param page the page to get
...@@ -1955,7 +1955,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1955,7 +1955,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Pager of project's issues. * Get a Pager of project's issues.
* *
* <pre><code>GET /projects/:id/issues</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/issues</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param itemsPerPage the number of issues per page * @param itemsPerPage the number of issues per page
...@@ -1971,7 +1971,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1971,7 +1971,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Stream of the project's issues. * Get a Stream of the project's issues.
* *
* <pre><code>GET /projects/:id/issues</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/issues</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @return a Stream of the project's issues * @return a Stream of the project's issues
...@@ -1986,7 +1986,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -1986,7 +1986,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a single project issue. * Get a single project issue.
* *
* <pre><code>GET /projects/:id/issues/:issue_iid</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/issues/:issue_iid</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param issueId the internal ID of a project's issue * @param issueId the internal ID of a project's issue
...@@ -2003,7 +2003,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2003,7 +2003,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Delete a project issue. * Delete a project issue.
* *
* <pre><code>DELETE /projects/:id/issues/:issue_iid</code></pre> * <pre><code>GitLab Endpoint: DELETE /projects/:id/issues/:issue_iid</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param issueId the internal ID of a project's issue * @param issueId the internal ID of a project's issue
...@@ -2019,7 +2019,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2019,7 +2019,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of the project snippets. * Get a list of the project snippets.
* *
* <pre><code>GET /projects/:id/snippets</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/snippets</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @return a list of the project's snippets * @return a list of the project's snippets
...@@ -2032,7 +2032,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2032,7 +2032,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of project snippets. * Get a list of project snippets.
* *
* <pre><code>GET /projects/:id/snippets</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/snippets</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param page the page to get * @param page the page to get
...@@ -2048,7 +2048,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2048,7 +2048,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Pager of project's snippets. * Get a Pager of project's snippets.
* *
* <pre><code>GET /projects/:id/snippets</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/snippets</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param itemsPerPage the number of snippets per page * @param itemsPerPage the number of snippets per page
...@@ -2062,7 +2062,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2062,7 +2062,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Stream of the project snippets. * Get a Stream of the project snippets.
* *
* <pre><code>GET /projects/:id/snippets</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/snippets</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @return a Stream of the project's snippets * @return a Stream of the project's snippets
...@@ -2075,7 +2075,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2075,7 +2075,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a single of project snippet. * Get a single of project snippet.
* *
* <pre><code>GET /projects/:id/snippets/:snippet_id</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/snippets/:snippet_id</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param snippetId the ID of the project's snippet * @param snippetId the ID of the project's snippet
...@@ -2090,7 +2090,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2090,7 +2090,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a single of project snippet as an Optional instance. * Get a single of project snippet as an Optional instance.
* *
* <pre><code>GET /projects/:id/snippets/:snippet_id</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/snippets/:snippet_id</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param snippetId the ID of the project's snippet * @param snippetId the ID of the project's snippet
...@@ -2107,7 +2107,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2107,7 +2107,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Creates a new project snippet. The user must have permission to create new snippets. * Creates a new project snippet. The user must have permission to create new snippets.
* *
* <pre><code>POST /projects/:id/snippets</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/snippets</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param title the title of a snippet, required * @param title the title of a snippet, required
...@@ -2135,7 +2135,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2135,7 +2135,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Updates an existing project snippet. The user must have permission to change an existing snippet. * Updates an existing project snippet. The user must have permission to change an existing snippet.
* *
* <pre><code>PUT /projects/:id/snippets/:snippet_id</code></pre> * <pre><code>GitLab Endpoint: PUT /projects/:id/snippets/:snippet_id</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param snippetId the ID of a project's snippet, required * @param snippetId the ID of a project's snippet, required
...@@ -2165,7 +2165,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2165,7 +2165,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* Deletes an existing project snippet. This is an idempotent function and deleting a * Deletes an existing project snippet. This is an idempotent function and deleting a
* non-existent snippet does not cause an error. * non-existent snippet does not cause an error.
* *
* <pre><code>DELETE /projects/:id/snippets/:snippet_id</code></pre> * <pre><code>GitLab Endpoint: DELETE /projects/:id/snippets/:snippet_id</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param snippetId the ID of the project's snippet * @param snippetId the ID of the project's snippet
...@@ -2178,7 +2178,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2178,7 +2178,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get the raw project snippet as plain text. * Get the raw project snippet as plain text.
* *
* <pre><code>GET /projects/:id/snippets/:snippet_id/raw</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/snippets/:snippet_id/raw</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param snippetId the ID of the project's snippet * @param snippetId the ID of the project's snippet
...@@ -2193,7 +2193,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2193,7 +2193,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get the raw project snippet plain text as an Optional instance. * Get the raw project snippet plain text as an Optional instance.
* *
* <pre><code>GET /projects/:id/snippets/:snippet_id/raw</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/snippets/:snippet_id/raw</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param snippetId the ID of the project's snippet * @param snippetId the ID of the project's snippet
...@@ -2210,7 +2210,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2210,7 +2210,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Share a project with the specified group. * Share a project with the specified group.
* *
* <pre><code>POST /projects/:id/share</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/share</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param groupId the ID of the group to share with, required * @param groupId the ID of the group to share with, required
...@@ -2230,7 +2230,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2230,7 +2230,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Unshare the project from the group. * Unshare the project from the group.
* *
* <pre><code>DELETE /projects/:id/share/:group_id</code></pre> * <pre><code>GitLab Endpoint: DELETE /projects/:id/share/:group_id</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param groupId the ID of the group to unshare, required * @param groupId the ID of the group to unshare, required
...@@ -2244,7 +2244,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2244,7 +2244,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Archive a project * Archive a project
* *
* <pre><code>POST /projects/:id/archive</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/archive</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @return the archived GitLab Project * @return the archived GitLab Project
...@@ -2259,7 +2259,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2259,7 +2259,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Unarchive a project * Unarchive a project
* *
* <pre><code>POST /projects/:id/unarchive</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/unarchive</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @return the unarchived GitLab Project * @return the unarchived GitLab Project
...@@ -2274,7 +2274,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2274,7 +2274,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Uploads a file to the specified project to be used in an issue or merge request description, or a comment. * Uploads a file to the specified project to be used in an issue or merge request description, or a comment.
* *
* <pre><code>POST /projects/:id/uploads</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/uploads</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param fileToUpload the File instance of the file to upload, required * @param fileToUpload the File instance of the file to upload, required
...@@ -2288,7 +2288,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2288,7 +2288,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Uploads a file to the specified project to be used in an issue or merge request description, or a comment. * Uploads a file to the specified project to be used in an issue or merge request description, or a comment.
* *
* <pre><code>POST /projects/:id/uploads</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/uploads</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param fileToUpload the File instance of the file to upload, required * @param fileToUpload the File instance of the file to upload, required
...@@ -2304,7 +2304,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2304,7 +2304,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get the project's push rules. * Get the project's push rules.
* *
* <pre><code>GET /projects/:id/push_rule</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/push_rule</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @return the push rules for the specified project * @return the push rules for the specified project
...@@ -2318,7 +2318,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2318,7 +2318,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Adds a push rule to a specified project. * Adds a push rule to a specified project.
* *
* <pre><code>POST /projects/:id/push_rule</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/push_rule</code></pre>
* *
* The following properties on the PushRules instance are utilized in the creation of the push rule: * The following properties on the PushRules instance are utilized in the creation of the push rule:
* *
...@@ -2356,7 +2356,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2356,7 +2356,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Updates a push rule for the specified project. * Updates a push rule for the specified project.
* *
* <pre><code>PUT /projects/:id/push_rule/:push_rule_id</code></pre> * <pre><code>GitLab Endpoint: PUT /projects/:id/push_rule/:push_rule_id</code></pre>
* *
* The following properties on the PushRules instance are utilized when updating the push rule: * The following properties on the PushRules instance are utilized when updating the push rule:
* *
...@@ -2395,7 +2395,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2395,7 +2395,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* Removes a push rule from a project. This is an idempotent method and can be * Removes a push rule from a project. This is an idempotent method and can be
* called multiple times. Either the push rule is available or not. * called multiple times. Either the push rule is available or not.
* *
* <pre><code>DELETE /projects/:id/push_rule</code></pre> * <pre><code>GitLab Endpoint: DELETE /projects/:id/push_rule</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @throws GitLabApiException if any exception occurs * @throws GitLabApiException if any exception occurs
...@@ -2407,7 +2407,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2407,7 +2407,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of projects that were forked from the specified project. * Get a list of projects that were forked from the specified project.
* *
* <pre><code>GET /projects/:id/forks</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/forks</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @return a List of forked projects * @return a List of forked projects
...@@ -2420,7 +2420,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2420,7 +2420,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a list of projects that were forked from the specified project and in the specified page range. * Get a list of projects that were forked from the specified project and in the specified page range.
* *
* <pre><code>GET /projects/:id/forks</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/forks</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param page the page to get * @param page the page to get
...@@ -2436,7 +2436,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2436,7 +2436,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Pager of projects that were forked from the specified project. * Get a Pager of projects that were forked from the specified project.
* *
* <pre><code>GET /projects/:id/forks</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/forks</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param itemsPerPage the number of Project instances that will be fetched per page * @param itemsPerPage the number of Project instances that will be fetched per page
...@@ -2450,7 +2450,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2450,7 +2450,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Stream of projects that were forked from the specified project. * Get a Stream of projects that were forked from the specified project.
* *
* <pre><code>GET /projects/:id/forks</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/forks</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @return a Stream of forked projects * @return a Stream of forked projects
...@@ -2463,7 +2463,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2463,7 +2463,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Star a project. * Star a project.
* *
* <pre><code>POST /projects/:id/star</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/star</code></pre>
* *
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @return a Project instance with the new project info * @return a Project instance with the new project info
...@@ -2478,7 +2478,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2478,7 +2478,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Unstar a project. * Unstar a project.
* *
* <pre><code>POST /projects/:id/unstar</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/unstar</code></pre>
* *
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @return a Project instance with the new project info * @return a Project instance with the new project info
...@@ -2493,7 +2493,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2493,7 +2493,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get languages used in a project with percentage value. * Get languages used in a project with percentage value.
* *
* <pre><code>GET /projects/:id/languages</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/languages</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @return a Map instance with the language as the key and the percentage as the value * @return a Map instance with the language as the key and the percentage as the value
...@@ -2508,7 +2508,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2508,7 +2508,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Transfer a project to a new namespace. This was added in GitLab 11.1 * Transfer a project to a new namespace. This was added in GitLab 11.1
* *
* <pre><code>PUT /projects/:id/transfer.</code></pre> * <pre><code>GitLab Endpoint: PUT /projects/:id/transfer.</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param namespace the namespace to transfer the project to * @param namespace the namespace to transfer the project to
...@@ -2524,7 +2524,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2524,7 +2524,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Uploads and sets the project avatar for the specified project. * Uploads and sets the project avatar for the specified project.
* *
* <pre><code>PUT /projects/:id/uploads</code></pre> * <pre><code>GitLab Endpoint: PUT /projects/:id/uploads</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param avatarFile the File instance of the avatar file to upload * @param avatarFile the File instance of the avatar file to upload
...@@ -2800,7 +2800,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2800,7 +2800,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Deletes a project variable. * Deletes a project variable.
* *
* <pre><code>DELETE /projects/:id/variables/:key</code></pre> * <pre><code>GitLab Endpoint: DELETE /projects/:id/variables/:key</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
* @param key the key of an existing variable, required * @param key the key of an existing variable, required
...@@ -2813,7 +2813,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2813,7 +2813,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a List of the project access requests viewable by the authenticated user. * Get a List of the project access requests viewable by the authenticated user.
* *
* <pre><code>GET /projects/:id/access_requests</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/access_requests</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return a List of project AccessRequest instances accessible by the authenticated user * @return a List of project AccessRequest instances accessible by the authenticated user
...@@ -2826,7 +2826,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2826,7 +2826,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Pager of the project access requests viewable by the authenticated user. * Get a Pager of the project access requests viewable by the authenticated user.
* *
* <pre><code>GET /projects/:id/access_requests</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/access_requests</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param itemsPerPage the number of AccessRequest instances that will be fetched per page * @param itemsPerPage the number of AccessRequest instances that will be fetched per page
...@@ -2840,7 +2840,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2840,7 +2840,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Get a Stream of the project access requests viewable by the authenticated user. * Get a Stream of the project access requests viewable by the authenticated user.
* *
* <pre><code>GET /projects/:id/access_requests</code></pre> * <pre><code>GitLab Endpoint: GET /projects/:id/access_requests</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return a Stream of project AccessRequest instances accessible by the authenticated user * @return a Stream of project AccessRequest instances accessible by the authenticated user
...@@ -2853,7 +2853,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2853,7 +2853,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Requests access for the authenticated user to the specified project. * Requests access for the authenticated user to the specified project.
* *
* <pre><code>POST /projects/:id/access_requests</code></pre> * <pre><code>GitLab Endpoint: POST /projects/:id/access_requests</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return the created AccessRequest instance * @return the created AccessRequest instance
...@@ -2867,7 +2867,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2867,7 +2867,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Approve access for the specified user to the specified project. * Approve access for the specified user to the specified project.
* *
* <pre><code>PUT /projects/:id/access_requests/:user_id/approve</code></pre> * <pre><code>GitLab Endpoint: PUT /projects/:id/access_requests/:user_id/approve</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param userId the user ID to approve access for * @param userId the user ID to approve access for
...@@ -2885,7 +2885,7 @@ public class ProjectApi extends AbstractApi implements Constants { ...@@ -2885,7 +2885,7 @@ public class ProjectApi extends AbstractApi implements Constants {
/** /**
* Deny access for the specified user to the specified project. * Deny access for the specified user to the specified project.
* *
* <pre><code>DELETE /projects/:id/access_requests/:user_id</code></pre> * <pre><code>GitLab Endpoint: DELETE /projects/:id/access_requests/:user_id</code></pre>
* *
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param userId the user ID to deny access for * @param userId the user ID to deny access for
......
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