Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
Menu
Open sidebar
佳 邓
Gitlab4j Api
Commits
638327d3
Commit
638327d3
authored
Jun 09, 2019
by
Greg Messner
Browse files
Cleaned up Javadocs.
parent
a8de5aae
Changes
3
Hide whitespace changes
Inline
Side-by-side
src/main/java/org/gitlab4j/api/ImportExportApi.java
View file @
638327d3
...
@@ -140,7 +140,7 @@ public class ImportExportApi extends AbstractApi {
...
@@ -140,7 +140,7 @@ public class ImportExportApi extends AbstractApi {
* <li>publicJobs (optional) - If true, jobs can be viewed by non-project-members</li>
* <li>publicJobs (optional) - If true, jobs can be viewed by non-project-members</li>
* <li>onlyAllowMergeIfPipelineSucceeds (optional) - Set whether merge requests can only be merged with successful jobs</li>
* <li>onlyAllowMergeIfPipelineSucceeds (optional) - Set whether merge requests can only be merged with successful jobs</li>
* <li>onlyAllowMergeIfAllDiscussionsAreResolved (optional) - Set whether merge requests can only be merged when all the discussions are resolved</li>
* <li>onlyAllowMergeIfAllDiscussionsAreResolved (optional) - Set whether merge requests can only be merged when all the discussions are resolved</li>
* <li>l
L
fsEnabled (optional) - Enable LFS</li>
* <li>lfsEnabled (optional) - Enable LFS</li>
* <li>requestAccessEnabled (optional) - Allow users to request member access</li>
* <li>requestAccessEnabled (optional) - Allow users to request member access</li>
* <li>repositoryStorage (optional) - Which storage shard the repository is on. Available only to admins</li>
* <li>repositoryStorage (optional) - Which storage shard the repository is on. Available only to admins</li>
* <li>approvalsBeforeMerge (optional) - How many approvers should approve merge request by default</li>
* <li>approvalsBeforeMerge (optional) - How many approvers should approve merge request by default</li>
...
...
src/main/java/org/gitlab4j/api/ProjectApi.java
View file @
638327d3
...
@@ -825,7 +825,7 @@ public class ProjectApi extends AbstractApi implements Constants {
...
@@ -825,7 +825,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* publicJobs (optional) - If true, jobs can be viewed by non-project-members
* publicJobs (optional) - If true, jobs can be viewed by non-project-members
* onlyAllowMergeIfPipelineSucceeds (optional) - Set whether merge requests can only be merged with successful jobs
* onlyAllowMergeIfPipelineSucceeds (optional) - Set whether merge requests can only be merged with successful jobs
* onlyAllowMergeIfAllDiscussionsAreResolved (optional) - Set whether merge requests can only be merged when all the discussions are resolved
* onlyAllowMergeIfAllDiscussionsAreResolved (optional) - Set whether merge requests can only be merged when all the discussions are resolved
* l
L
fsEnabled (optional) - Enable LFS
* lfsEnabled (optional) - Enable LFS
* requestAccessEnabled (optional) - Allow users to request member access
* requestAccessEnabled (optional) - Allow users to request member access
* repositoryStorage (optional) - Which storage shard the repository is on. Available only to admins
* repositoryStorage (optional) - Which storage shard the repository is on. Available only to admins
* approvalsBeforeMerge (optional) - How many approvers should approve merge request by default
* approvalsBeforeMerge (optional) - How many approvers should approve merge request by default
...
@@ -1065,7 +1065,7 @@ public class ProjectApi extends AbstractApi implements Constants {
...
@@ -1065,7 +1065,7 @@ public class ProjectApi extends AbstractApi implements Constants {
* publicJobs (optional) - If true, jobs can be viewed by non-project-members
* publicJobs (optional) - If true, jobs can be viewed by non-project-members
* onlyAllowMergeIfPipelineSucceeds (optional) - Set whether merge requests can only be merged with successful jobs
* onlyAllowMergeIfPipelineSucceeds (optional) - Set whether merge requests can only be merged with successful jobs
* onlyAllowMergeIfAllDiscussionsAreResolved (optional) - Set whether merge requests can only be merged when all the discussions are resolved
* onlyAllowMergeIfAllDiscussionsAreResolved (optional) - Set whether merge requests can only be merged when all the discussions are resolved
* l
L
fsEnabled (optional) - Enable LFS
* lfsEnabled (optional) - Enable LFS
* requestAccessEnabled (optional) - Allow users to request member access
* requestAccessEnabled (optional) - Allow users to request member access
* repositoryStorage (optional) - Which storage shard the repository is on. Available only to admins
* repositoryStorage (optional) - Which storage shard the repository is on. Available only to admins
* approvalsBeforeMerge (optional) - How many approvers should approve merge request by default
* approvalsBeforeMerge (optional) - How many approvers should approve merge request by default
...
...
src/main/java/org/gitlab4j/api/ProtectedBranchesApi.java
View file @
638327d3
...
@@ -9,6 +9,10 @@ import javax.ws.rs.core.Response;
...
@@ -9,6 +9,10 @@ import javax.ws.rs.core.Response;
import
org.gitlab4j.api.models.AccessLevel
;
import
org.gitlab4j.api.models.AccessLevel
;
import
org.gitlab4j.api.models.ProtectedBranch
;
import
org.gitlab4j.api.models.ProtectedBranch
;
/**
* This class provides an entry point to all the Protected Branches API calls.
* @see <a https://docs.gitlab.com/ee/api/protected_branches.html">Protected branches API at GitLab</a>
*/
public
class
ProtectedBranchesApi
extends
AbstractApi
{
public
class
ProtectedBranchesApi
extends
AbstractApi
{
public
ProtectedBranchesApi
(
GitLabApi
gitLabApi
)
{
public
ProtectedBranchesApi
(
GitLabApi
gitLabApi
)
{
...
@@ -62,7 +66,7 @@ public class ProtectedBranchesApi extends AbstractApi {
...
@@ -62,7 +66,7 @@ public class ProtectedBranchesApi extends AbstractApi {
* <pre><code>GitLab Endpoint: DELETE /projects/:id/protected_branches/:name</code></pre>
* <pre><code>GitLab Endpoint: DELETE /projects/:id/protected_branches/:name</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 branchName the name of the branch to un-protect
* @param branchName the name of the branch to un-protect
, can be a wildcard
* @throws GitLabApiException if any exception occurs
* @throws GitLabApiException if any exception occurs
*/
*/
public
void
unprotectBranch
(
Integer
projectIdOrPath
,
String
branchName
)
throws
GitLabApiException
{
public
void
unprotectBranch
(
Integer
projectIdOrPath
,
String
branchName
)
throws
GitLabApiException
{
...
@@ -75,7 +79,7 @@ public class ProtectedBranchesApi extends AbstractApi {
...
@@ -75,7 +79,7 @@ public class ProtectedBranchesApi extends AbstractApi {
* <pre><code>GitLab Endpoint: POST /projects/:id/protected_branches</code></pre>
* <pre><code>GitLab Endpoint: POST /projects/:id/protected_branches</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 branchName the name of the branch to protect
* @param branchName the name of the branch to protect
, can be a wildcard
* @return the branch info for the protected branch
* @return the branch info for the protected branch
* @throws GitLabApiException if any exception occurs
* @throws GitLabApiException if any exception occurs
*/
*/
...
@@ -89,7 +93,7 @@ public class ProtectedBranchesApi extends AbstractApi {
...
@@ -89,7 +93,7 @@ public class ProtectedBranchesApi extends AbstractApi {
* <pre><code>GitLab Endpoint: POST /projects/:id/protected_branches</code></pre>
* <pre><code>GitLab Endpoint: POST /projects/:id/protected_branches</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 branchName the name of the branch to protect
* @param branchName the name of the branch to protect
, can be a wildcard
* @param pushAccessLevel Access levels allowed to push (defaults: 40, maintainer access level)
* @param pushAccessLevel Access levels allowed to push (defaults: 40, maintainer access level)
* @param mergeAccessLevel Access levels allowed to merge (defaults: 40, maintainer access level)
* @param mergeAccessLevel Access levels allowed to merge (defaults: 40, maintainer access level)
* @return the branch info for the protected branch
* @return the branch info for the protected branch
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment