Skip to content
GitLab
Commit 929c74da authored by Greg Messner's avatar Greg Messner
Browse files

Cleaned up Javadoc around GitLab endpoints.

parent 7d17dc25
Hide whitespace changes
Inline Side-by-side
src/main/java/org/gitlab4j/api/EventsApi.java
View file @ 929c74da
......@@ -21,7 +21,7 @@ public class EventsApi extends AbstractApi {
/**
* Get a list of events for the authenticated user.
*
* GET /events
* <pre><code>GitLab Endpoint: GET /events</code></pre>
*
* @param action include only events of a particular action type, optional
* @param targetType include only events of a particular target type, optional
......@@ -39,7 +39,7 @@ public class EventsApi extends AbstractApi {
/**
* Get a list of events for the authenticated user and in the specified page range.
*
* GET /events
* <pre><code>GitLab Endpoint: GET /events</code></pre>
*
* @param action include only events of a particular action type, optional
* @param targetType include only events of a particular target type, optional
......@@ -70,7 +70,7 @@ public class EventsApi extends AbstractApi {
/**
* Get a list of events for the authenticated user and in the specified page range.
*
* GET /events
* <pre><code>GitLab Endpoint: GET /events</code></pre>
*
* @param action include only events of a particular action type, optional
* @param targetType include only events of a particular target type, optional
......@@ -97,7 +97,7 @@ public class EventsApi extends AbstractApi {
/**
* Get a Stream of events for the authenticated user.
*
* GET /events
* <pre><code>GitLab Endpoint: GET /events</code></pre>
*
* @param action include only events of a particular action type, optional
* @param targetType include only events of a particular target type, optional
......@@ -115,7 +115,7 @@ public class EventsApi extends AbstractApi {
/**
* Get a list of events for the specified user.
*
* GET /users/:userId/events
* <pre><code>GitLab Endpoint: GET /users/:userId/events</code></pre>
*
* @param userIdOrUsername the user ID, username of the user, or a User instance holding the user ID or username
* @param action include only events of a particular action type, optional
......@@ -134,7 +134,7 @@ public class EventsApi extends AbstractApi {
/**
* Get a list of events for the specified user and in the specified page range.
*
* GET /users/:userId/events
* <pre><code>GitLab Endpoint: GET /users/:userId/events</code></pre>
*
* @param userIdOrUsername the user ID, username of the user, or a User instance holding the user ID or username
* @param action include only events of a particular action type, optional
......@@ -167,7 +167,7 @@ public class EventsApi extends AbstractApi {
/**
* Get a list of events for the specified user and in the specified page range.
*
* GET /users/:userId/events
* <pre><code>GitLab Endpoint: GET /users/:userId/events</code></pre>
*
* @param userIdOrUsername the user ID, username of the user, or a User instance holding the user ID or username
* @param action include only events of a particular action type, optional
......@@ -196,7 +196,7 @@ public class EventsApi extends AbstractApi {
/**
* Get a Stream of events for the specified user.
*
* GET /users/:userId/events
* <pre><code>GitLab Endpoint: GET /users/:userId/events</code></pre>
*
* @param userIdOrUsername the user ID, username of the user, or a User instance holding the user ID or username
* @param action include only events of a particular action type, optional
......@@ -215,7 +215,7 @@ public class EventsApi extends AbstractApi {
/**
* Get a list of events for the specified project.
*
* GET /:projectId/events
* <pre><code>GitLab Endpoint: GET /:projectId/events</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param action include only events of a particular action type, optional
......@@ -234,7 +234,7 @@ public class EventsApi extends AbstractApi {
/**
* Get a list of events for the specified project and in the specified page range.
*
* GET /projects/:projectId/events
* <pre><code>GitLab Endpoint: GET /projects/:projectId/events</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param action include only events of a particular action type, optional
......@@ -267,7 +267,7 @@ public class EventsApi extends AbstractApi {
/**
* Get a list of events for the specified project and in the specified page range.
*
* GET /projects/:projectId/events
* <pre><code>GitLab Endpoint: GET /projects/:projectId/events</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param action include only events of a particular action type, optional
......@@ -296,7 +296,7 @@ public class EventsApi extends AbstractApi {
/**
* Get a Stream of events for the specified project.
*
* GET /:projectId/events
* <pre><code>GitLab Endpoint: GET /:projectId/events</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param action include only events of a particular action type, optional
......
src/main/java/org/gitlab4j/api/HealthCheckApi.java
View file @ 929c74da
......@@ -18,7 +18,7 @@ public class HealthCheckApi extends AbstractApi {
* Requires ip_whitelist, see the following link for more info:
* See <a href="https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html">https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html</a>
*
* GET /-/liveness
* <pre><code>GitLab Endpoint: GET /-/liveness</code></pre>
*
* @return HealthCheckInfo instance
* @throws GitLabApiException if any exception occurs
......@@ -30,7 +30,7 @@ public class HealthCheckApi extends AbstractApi {
/**
* Get Health Checks from the liveness endpoint.
*
* GET /-/liveness
* <pre><code>GitLab Endpoint: GET /-/liveness</code></pre>
*
* @param token Health Status token
* @return HealthCheckInfo instance
......@@ -54,7 +54,7 @@ public class HealthCheckApi extends AbstractApi {
* Requires ip_whitelist, see the following link for more info:
* See <a href="https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html">https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html</a>
*
* GET /-/readiness
* <pre><code>GitLab Endpoint: GET /-/readiness</code></pre>
*
* @return HealthCheckInfo instance
* @throws GitLabApiException if any exception occurs
......@@ -66,7 +66,7 @@ public class HealthCheckApi extends AbstractApi {
/**
* Get Health Checks from the readiness endpoint.
*
* GET /-/readiness
* <pre><code>GitLab Endpoint: GET /-/readiness</code></pre>
*
* @param token Health Status token
* @return HealthCheckInfo instance
......
src/main/java/org/gitlab4j/api/NotificationSettingsApi.java
View file @ 929c74da
......@@ -14,7 +14,7 @@ public class NotificationSettingsApi extends AbstractApi {
/**
* Get the global notification settings.
*
* GET /notification_settings
* <pre><code>GitLab Endpoint: GET /notification_settings</code></pre>
*
* @return a NotificationSettings instance containing the global notification settings
* @throws GitLabApiException if any exception occurs
......@@ -27,7 +27,7 @@ public class NotificationSettingsApi extends AbstractApi {
/**
* Update the global notification settings.
*
* PUT /notification_settings
* <pre><code>GitLab Endpoint: PUT /notification_settings</code></pre>
*
* @param settings a NotificationSettings instance with the new settings
* @return a NotificationSettings instance containing the updated global notification settings
......@@ -62,7 +62,7 @@ public class NotificationSettingsApi extends AbstractApi {
/**
* Get the notification settings for a group.
*
* GET /groups/:id/notification_settings
* <pre><code>GitLab Endpoint: GET /groups/:id/notification_settings</code></pre>
*
* @param groupId the group ID to get the notification settings for
* @return a NotificationSettings instance containing the specified group's notification settings
......@@ -76,7 +76,7 @@ public class NotificationSettingsApi extends AbstractApi {
/**
* Update the notification settings for a group
*
* PUT /groups/:id/notification_settings
* <pre><code>GitLab Endpoint: PUT /groups/:id/notification_settings</code></pre>
*
* @param groupId the group ID to update the notification settings for
* @param settings a NotificationSettings instance with the new settings
......@@ -112,7 +112,7 @@ public class NotificationSettingsApi extends AbstractApi {
/**
* Get the notification settings for a project.
*
* GET /projects/:id/notification_settings
* <pre><code>GitLab Endpoint: GET /projects/:id/notification_settings</code></pre>
*
* @param projectId the project ID to get the notification settings for
* @return a NotificationSettings instance containing the specified project's notification settings
......@@ -126,7 +126,7 @@ public class NotificationSettingsApi extends AbstractApi {
/**
* Update the notification settings for a project
*
* PUT /projects/:id/notification_settings
* <pre><code>GitLab Endpoint: PUT /projects/:id/notification_settings</code></pre>
*
* @param projectId the project ID to update the notification settings for
* @param settings a NotificationSettings instance with the new settings
......
src/main/java/org/gitlab4j/api/RepositoryApi.java
View file @ 929c74da
......@@ -34,7 +34,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a list of repository branches from a project, sorted by name alphabetically.
*
* GET /projects/:id/repository/branches
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/branches</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return the list of repository branches for the specified project
......@@ -47,7 +47,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a list of repository branches from a project, sorted by name alphabetically.
*
* GET /projects/:id/repository/branches
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/branches</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param page the page to get
......@@ -64,7 +64,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a Pager of repository branches from a project, sorted by name alphabetically.
*
* GET /projects/:id/repository/branches
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/branches</code></pre>
*
* @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
......@@ -80,7 +80,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a Stream of repository branches from a project, sorted by name alphabetically.
*
* GET /projects/:id/repository/branches
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/branches</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return a Stream of repository branches for the specified project
......@@ -93,11 +93,11 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a single project repository branch.
*
* GET /projects/:id/repository/branches/:branch
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/branches/:branch</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param branchName the name of the branch to get
* @return the branch info for the specified project ID/branch name pair
* @return the branch info for the specified project ID/branch name pair</code></pre>
* @throws GitLabApiException if any exception occurs
*/
public Branch getBranch(Object projectIdOrPath, String branchName) throws GitLabApiException {
......@@ -109,7 +109,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get an Optional instance with the value for the specific repository branch.
*
* GET /projects/:id/repository/branches/:branch
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/branches/:branch</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param branchName the name of the branch to get
......@@ -127,7 +127,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Creates a branch for the project. Support as of version 6.8.x
*
* POST /projects/:id/repository/branches
* <pre><code>GitLab Endpoint: POST /projects/:id/repository/branches</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param branchName the name of the branch to create
......@@ -148,7 +148,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Delete a single project repository branch.
*
* DELETE /projects/:id/repository/branches/:branch
* <pre><code>GitLab Endpoint: DELETE /projects/:id/repository/branches/:branch</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param branchName the name of the branch to delete
......@@ -164,7 +164,7 @@ public class RepositoryApi extends AbstractApi {
* Protects a single project repository branch. This is an idempotent function,
* protecting an already protected repository branch will not produce an error.
*
* PUT /projects/:id/repository/branches/:branch/protect
* <pre><code>GitLab Endpoint: PUT /projects/:id/repository/branches/:branch/protect</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param branchName the name of the branch to protect
......@@ -181,7 +181,7 @@ public class RepositoryApi extends AbstractApi {
* Unprotects a single project repository branch. This is an idempotent function, unprotecting an
* already unprotected repository branch will not produce an error.
*
* PUT /projects/:id/repository/branches/:branch/unprotect
* <pre><code>GitLab Endpoint: PUT /projects/:id/repository/branches/:branch/unprotect</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param branchName the name of the branch to un-protect
......@@ -197,7 +197,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a list of repository tags from a project, sorted by name in reverse alphabetical order.
*
* GET /projects/:id/repository/tags
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/tags</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return the list of tags for the specified project ID
......@@ -214,7 +214,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a list of repository tags from a project, sorted by name in reverse alphabetical order and in the specified page range.
*
* GET /projects/:id/repository/tags
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/tags</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param page the page to get
......@@ -233,7 +233,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a list of repository tags from a project, sorted by name in reverse alphabetical order.
*
* GET /projects/:id/repository/tags
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/tags</code></pre>
*
* @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
......@@ -250,7 +250,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Creates a tag on a particular ref of the given project. A message and release notes are optional.
*
* POST /projects/:id/repository/tags
* <pre><code>GitLab Endpoint: POST /projects/:id/repository/tags</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param tagName The name of the tag Must be unique for the project
......@@ -278,7 +278,7 @@ public class RepositoryApi extends AbstractApi {
* release notes are optional. This method is the same as {@link #createTag(Object, String, String, String, String)},
* but instead allows the release notes to be supplied in a file.
*
* POST /projects/:id/repository/tags
* <pre><code>GitLab Endpoint: POST /projects/:id/repository/tags</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param tagName the name of the tag, must be unique for the project
......@@ -308,7 +308,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Deletes the tag from a project with the specified tag name.
*
* DELETE /projects/:id/repository/tags/:tag_name
* <pre><code>GitLab Endpoint: DELETE /projects/:id/repository/tags/:tag_name</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param tagName The name of the tag to delete
......@@ -323,7 +323,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a list of repository files and directories in a project.
*
* GET /projects/:id/repository/tree
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/tree</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return a tree with the root directories and files of a project
......@@ -336,7 +336,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a Pager of repository files and directories in a project.
*
* GET /projects/:id/repository/tree
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/tree</code></pre>
*
* @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
......@@ -350,7 +350,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a list of repository files and directories in a project.
*
* GET /projects/:id/repository/tree
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/tree</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return a Stream containing a tree with the root directories and files of a project
......@@ -363,7 +363,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a list of repository files and directories in a project.
*
* GET /projects/:id/repository/tree
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/tree</code></pre>
*
* id (required) - The ID of a project
* path (optional) - The path inside repository. Used to get content of subdirectories
......@@ -382,7 +382,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a Pager of repository files and directories in a project.
*
* GET /projects/:id/repository/tree
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/tree</code></pre>
*
* id (required) - The ID of a project
* path (optional) - The path inside repository. Used to get content of subdirectories
......@@ -402,7 +402,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a Stream of repository files and directories in a project.
*
* GET /projects/:id/repository/tree
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/tree</code></pre>
*
* id (required) - The ID of a project
* path (optional) - The path inside repository. Used to get content of subdirectories
......@@ -421,7 +421,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a list of repository files and directories in a project.
*
* GET /projects/:id/repository/tree
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/tree</code></pre>
*
* id (required) - The ID of a project
* path (optional) - The path inside repository. Used to get contend of subdirectories
......@@ -442,7 +442,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a Pager of repository files and directories in a project.
*
* GET /projects/:id/repository/tree
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/tree</code></pre>
*
* id (required) - The ID of a project
* path (optional) - The path inside repository. Used to get contend of subdirectories
......@@ -470,7 +470,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a Stream of repository files and directories in a project.
*
* GET /projects/:id/repository/tree
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/tree</code></pre>
*
* id (required) - The ID of a project
* path (optional) - The path inside repository. Used to get contend of subdirectories
......@@ -491,7 +491,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get the raw file contents for a blob by blob SHA.
*
* GET /projects/:id/repository/raw_blobs/:sha
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/raw_blobs/:sha</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param sha the SHA of the file to get the contents for
......@@ -507,7 +507,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get an archive of the complete repository by SHA (optional).
*
* GET /projects/:id/repository/archive
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/archive</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param sha the SHA of the archive to get
......@@ -525,7 +525,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get an archive of the complete repository by SHA (optional).
*
* GET /projects/:id/repository/archive
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/archive</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param sha the SHA of the archive to get
......@@ -541,7 +541,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get an archive of the complete repository by SHA (optional).
*
* GET /projects/:id/repository/archive
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/archive</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param sha the SHA of the archive to get
......@@ -572,7 +572,7 @@ public class RepositoryApi extends AbstractApi {
* Get an archive of the complete repository by SHA (optional) and saves to the specified directory.
* If the archive already exists in the directory it will be overwritten.
*
* GET /projects/:id/repository/archive
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/archive</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param sha the SHA of the archive to get
......@@ -607,7 +607,7 @@ public class RepositoryApi extends AbstractApi {
* Get an archive of the complete repository by SHA (optional) and saves to the specified directory.
* If the archive already exists in the directory it will be overwritten.
*
* GET /projects/:id/repository/archive
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/archive</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param sha the SHA of the archive to get
......@@ -625,7 +625,7 @@ public class RepositoryApi extends AbstractApi {
* Get an archive of the complete repository by SHA (optional) and saves to the specified directory.
* If the archive already exists in the directory it will be overwritten.
*
* GET /projects/:id/repository/archive
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/archive</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param sha the SHA of the archive to get
......@@ -688,7 +688,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a list of contributors from a project.
*
* GET /projects/:id/repository/contributors
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/contributors</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return a List containing the contributors for the specified project ID
......@@ -701,7 +701,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a list of contributors from a project and in the specified page range.
*
* GET /projects/:id/repository/contributors
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/contributors</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param page the page to get
......@@ -718,7 +718,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a Pager of contributors from a project.
*
* GET /projects/:id/repository/contributors
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/contributors</code></pre>
*
* @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
......@@ -733,7 +733,7 @@ public class RepositoryApi extends AbstractApi {
/**
* Get a list of contributors from a project.
*
* GET /projects/:id/repository/contributors
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/contributors</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @return a List containing the contributors for the specified project ID
......
src/main/java/org/gitlab4j/api/RepositoryFileApi.java
View file @ 929c74da
......@@ -28,7 +28,7 @@ public class RepositoryFileApi extends AbstractApi {
* Allows you to receive information about file in repository like name, size.
* Only works with GitLab 11.1.0+, value will be an empty object for earlier versions of GitLab.
*
* HEAD /projects/:id/repository/files
* <pre><code>GitLab Endpoint: HEAD /projects/:id/repository/files</code></pre>
*
* @param projectIdOrPath the id, path of the project, or a Project instance holding the project ID or path
* @param filePath (required) - Full path to the file. Ex. lib/class.rb
......@@ -48,7 +48,7 @@ public class RepositoryFileApi extends AbstractApi {
* Get information on a file in the repository. Allows you to receive information about file in repository like name, size.
* Only works with GitLab 11.1.0+, returns an empty object for earlier versions of GitLab.
*
* HEAD /projects/:id/repository/files
* <pre><code>GitLab Endpoint: HEAD /projects/:id/repository/files</code></pre>
*
* @param projectIdOrPath the id, path of the project, or a Project instance holding the project ID or path
* @param filePath (required) - Full path to the file. Ex. lib/class.rb
......@@ -84,7 +84,7 @@ public class RepositoryFileApi extends AbstractApi {
* Allows you to receive information about file in repository like name, size, and content.
* Only works with GitLab 11.1.0+, value will be an empty object for earlier versions of GitLab.
*
* HEAD /projects/:id/repository/files
* <pre><code>GitLab Endpoint: HEAD /projects/:id/repository/files</code></pre>
*
* @param projectIdOrPath the id, path of the project, or a Project instance holding the project ID or path
* @param filePath (required) - Full path to the file. Ex. lib/class.rb
......@@ -103,7 +103,7 @@ public class RepositoryFileApi extends AbstractApi {
* Get file from repository. Allows you to receive information about file in repository like name, size, content.
* Note that file content is Base64 encoded.
*
* GET /projects/:id/repository/files
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/files</code></pre>
*
* @param projectIdOrPath the id, path of the project, or a Project instance holding the project ID or path
* @param filePath (required) - Full path to the file. Ex. lib/class.rb
......@@ -119,7 +119,7 @@ public class RepositoryFileApi extends AbstractApi {
* Get file from repository. Allows you to receive information about file in repository like name, size, content.
* Note that file content is Base64 encoded.
*
* GET /projects/:id/repository/files
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/files</code></pre>
*
* @param filePath (required) - Full path to the file. Ex. lib/class.rb
* @param projectId (required) - the project ID
......@@ -142,7 +142,7 @@ public class RepositoryFileApi extends AbstractApi {
* Get file from repository. Allows you to receive information about file in repository like name, size, and optionally content.
* Note that file content is Base64 encoded.
*
* GET /projects/:id/repository/files
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/files</code></pre>
*
* @param projectIdOrPath the id, path of the project, or a Project instance holding the project ID or path
* @param filePath (required) - Full path to the file. Ex. lib/class.rb
......@@ -167,7 +167,7 @@ public class RepositoryFileApi extends AbstractApi {
* Get file from repository. Allows you to receive information about file in repository like name, size, content.
* Note that file content is Base64 encoded.
*
* GET /projects/:id/repository/files
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/files</code></pre>
*
* @param filePath (required) - Full path to new file. Ex. lib/class.rb
* @param projectId (required) - the project ID
......@@ -188,7 +188,7 @@ public class RepositoryFileApi extends AbstractApi {
/**
* Create new file in repository
*
* POST /projects/:id/repository/files
* <pre><code>GitLab Endpoint: POST /projects/:id/repository/files</code></pre>
*
* file_path (required) - Full path to new file. Ex. lib/class.rb
* branch_name (required) - The name of branch
......@@ -221,7 +221,7 @@ public class RepositoryFileApi extends AbstractApi {
/**
* Create new file in repository
*
* POST /projects/:id/repository/files
* <pre><code>GitLab Endpoint: POST /projects/:id/repository/files</code></pre>
*
* file_path (required) - Full path to new file. Ex. lib/class.rb
* branch_name (required) - The name of branch
......@@ -245,7 +245,7 @@ public class RepositoryFileApi extends AbstractApi {
/**
* Update existing file in repository
*
* PUT /projects/:id/repository/files
* <pre><code>GitLab Endpoint: PUT /projects/:id/repository/files</code></pre>
*
* file_path (required) - Full path to new file. Ex. lib/class.rb
* branch_name (required) - The name of branch
......@@ -278,7 +278,7 @@ public class RepositoryFileApi extends AbstractApi {
/**
* Update existing file in repository
*
* PUT /projects/:id/repository/files
* <pre><code>GitLab Endpoint: PUT /projects/:id/repository/files</code></pre>
*
* file_path (required) - Full path to new file. Ex. lib/class.rb
* branch_name (required) - The name of branch
......@@ -302,7 +302,7 @@ public class RepositoryFileApi extends AbstractApi {
/**
* Delete existing file in repository
*
* DELETE /projects/:id/repository/files
* <pre><code>GitLab Endpoint: DELETE /projects/:id/repository/files</code></pre>
*
* file_path (required) - Full path to file. Ex. lib/class.rb
* branch_name (required) - The name of branch
......@@ -336,7 +336,7 @@ public class RepositoryFileApi extends AbstractApi {
/**
* Delete existing file in repository
*
* DELETE /projects/:id/repository/files
* <pre><code>GitLab Endpoint: DELETE /projects/:id/repository/files</code></pre>
*
* file_path (required) - Full path to file. Ex. lib/class.rb
* branch_name (required) - The name of branch
......@@ -359,10 +359,10 @@ public class RepositoryFileApi extends AbstractApi {
* If the file already exists in the directory it will be overwritten.
*
* V3:
* GET /projects/:id/repository/blobs/:sha
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/blobs/:sha</code></pre>
*
* V4:
* GET /projects/:id/repository/files/:filepath
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/files/:filepath</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param commitOrBranchName the commit or branch name to get the file for
......@@ -401,10 +401,10 @@ public class RepositoryFileApi extends AbstractApi {
* Get the raw file contents for a file by commit sha and path.
*
* V3:
* GET /projects/:id/repository/blobs/:sha
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/blobs/:sha</code></pre>
*
* V4:
* GET /projects/:id/repository/files/:filepath
* <pre><code>GitLab Endpoint: GET /projects/:id/repository/files/:filepath</code></pre>
*
* @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
* @param commitOrBranchName the commit or branch name to get the file contents for
......
src/main/java/org/gitlab4j/api/ServicesApi.java
View file @ 929c74da
......@@ -21,8 +21,8 @@ public class ServicesApi extends AbstractApi {
/**
* Activates the gitlab-ci service for a project.
* <p>
* PUT /projects/:id/services/gitlab-ci
*
* <pre><code>GitLab Endpoint: PUT /projects/:id/services/gitlab-ci</code></pre>
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @param token for authentication
......@@ -39,8 +39,8 @@ public class ServicesApi extends AbstractApi {
/**
* Deletes the gitlab-ci service for a project.
* <p>
* DELETE /projects/:id/services/gitlab-ci
*
* <pre><code>GitLab Endpoint: DELETE /projects/:id/services/gitlab-ci</code></pre>
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @throws GitLabApiException if any exception occurs
......@@ -53,8 +53,8 @@ public class ServicesApi extends AbstractApi {
/**
* Get the HipChatService notification configuration for a project.
* <p>
* Get /projects/:id/services/hipchat
*
* <pre><code>GitLab Endpoint: GET /projects/:id/services/hipchat</code></pre>
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @return a HipChatService instance holding the HipChatService notification settings
......@@ -67,9 +67,9 @@ public class ServicesApi extends AbstractApi {
/**
* Updates the HipChatService notification settings for a project.
* <p>
* PUT /projects/:id/services/hipchat
* <p>
*
* <pre><code>GitLab Endpoint: PUT /projects/:id/services/hipchat</code></pre>
*
* The following properties on the HipChatService instance are utilized in the update of the settings:
* <p>
* pushEvents (optional) - Enable notifications for push events
......@@ -116,8 +116,8 @@ public class ServicesApi extends AbstractApi {
/**
* Activates HipChatService notifications.
* <p>
* PUT /projects/:id/services/hipchat
*
* <pre><code>GitLab Endpoint: PUT /projects/:id/services/hipchat</code></pre>
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @param token for authentication
......@@ -136,8 +136,8 @@ public class ServicesApi extends AbstractApi {
/**
* Deletes the HipChatService service for a project.
* <p>
* DELETE /projects/:id/services/hipchat
*
* <pre><code>GitLab Endpoint: DELETE /projects/:id/services/hipchat</code></pre>
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @throws GitLabApiException if any exception occurs
......@@ -149,8 +149,8 @@ public class ServicesApi extends AbstractApi {
/**
* Deletes the HipChatService service for a project.
* <p>
* DELETE /projects/:id/services/hipchat
*
* <pre><code>GitLab Endpoint: DELETE /projects/:id/services/hipchat</code></pre>
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @throws GitLabApiException if any exception occurs
......@@ -162,8 +162,8 @@ public class ServicesApi extends AbstractApi {
/**
* Get the Slack notification settings for a project.
* <p>
* Get /projects/:id/services/slack
*
* <pre><code>GitLab Endpoint: GET /projects/:id/services/slack</code></pre>
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @return a SlackService instance holding the Slack notification settings
......@@ -176,9 +176,9 @@ public class ServicesApi extends AbstractApi {
/**
* Updates the Slack notification settings for a project.
* <p>
* PUT /projects/:id/services/slack
* <p>
*
* <pre><code>GitLab Endpoint: PUT /projects/:id/services/slack</code></pre>
*
* The following properties on the SlackService instance are utilized in the update of the settings:
* <p>
* webhook (required) - https://hooks.slack.com/services/...
......@@ -241,8 +241,8 @@ public class ServicesApi extends AbstractApi {
/**
* Deletes the Slack notifications service for a project.
* <p>
* DELETE /projects/:id/services/slack
*
* <pre><code>GitLab Endpoint: DELETE /projects/:id/services/slack</code></pre>
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @throws GitLabApiException if any exception occurs
......@@ -254,8 +254,8 @@ public class ServicesApi extends AbstractApi {
/**
* Get the JIRA service settings for a project.
* <p>
* Get /projects/:id/services/jira
*
* <pre><code>GitLab Endpoint: GET /projects/:id/services/jira</code></pre>
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @return a JiraService instance holding the JIRA service settings
......@@ -268,9 +268,9 @@ public class ServicesApi extends AbstractApi {
/**
* Updates the JIRA service settings for a project.
* <p>
* PUT /projects/:id/services/jira
* <p>
*
* <pre><code>GitLab Endpoint: PUT /projects/:id/services/jira</code></pre>
*
* The following properties on the JiraService instance are utilized in the update of the settings:
* <p>
* mergeRequestsEvents (optional) - Enable notifications for merge request events
......@@ -301,13 +301,10 @@ public class ServicesApi extends AbstractApi {
return (response.readEntity(JiraService.class));
}
/**
* Deletes the JIRA service for a project.
* <p>
* DELETE /projects/:id/services/jira
*
* <pre><code>GitLab Endpoint: DELETE /projects/:id/services/jira</code></pre>
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @throws GitLabApiException if any exception occurs
......@@ -317,11 +314,10 @@ public class ServicesApi extends AbstractApi {
delete(expectedStatus, null, "projects", getProjectIdOrPath(projectIdOrPath), "services", "jira");
}
/**
* Get the JIRA service settings for a project.
* <p>
* Get /projects/:id/services/external-wiki
*
* <pre><code>GitLab Endpoint: GET /projects/:id/services/external-wiki</code></pre>
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @return a ExternalWikiService instance holding the External Wiki service settings
......@@ -332,12 +328,11 @@ public class ServicesApi extends AbstractApi {
return (response.readEntity(ExternalWikiService.class));
}
/**
* Updates the ExternalWikiService service settings for a project.
* <p>
* PUT /projects/:id/services/external-wiki
* <p>
*
* <pre><code>GitLab Endpoint: PUT /projects/:id/services/external-wiki</code></pre>
*
* The following properties on the JiraService instance are utilized in the update of the settings:
* <p>
* external_wiki_url (required) - The URL to the External Wiki project which is being linked to this GitLab project, e.g., http://www.wikidot.com/
......@@ -356,8 +351,8 @@ public class ServicesApi extends AbstractApi {
/**
* Deletes the ExternalWiki service for a project.
* <p>
* DELETE /projects/:id/services/external-wiki
*
* <pre><code>GitLab Endpoint: DELETE /projects/:id/services/external-wiki</code></pre>
*
* @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
* @throws GitLabApiException if any exception occurs
......
src/main/java/org/gitlab4j/api/SessionApi.java
View file @ 929c74da
......@@ -17,7 +17,7 @@ public class SessionApi extends AbstractApi {
/**
* Login to get private token. This functionality is not available on GitLab servers 10.2 and above.
*
* POST /session
* <pre><code>GitLab Endpoint: POST /session</code></pre>
*
* @param username the username to login
* @param email the email address to login
......
src/main/java/org/gitlab4j/api/WikisApi.java
View file @ 929c74da
......@@ -23,13 +23,13 @@
package org.gitlab4j.api;
import org.gitlab4j.api.models.WikiPage;
import java.util.List;
import java.util.Optional;
import javax.ws.rs.core.GenericType;
import javax.ws.rs.core.Response;
import java.util.List;
import java.util.Optional;
import java.util.stream.Stream;
import org.gitlab4j.api.models.WikiPage;
/**
* This class implements the client side API for the GitLab Wikis API.
......
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