Skip to content

Commit 5e5e8b3

Browse files
committed
Added comments about login not being supported in version 10.2.0+
1 parent b6e0600 commit 5e5e8b3

File tree

2 files changed

+21
-11
lines changed

2 files changed

+21
-11
lines changed

src/main/java/org/gitlab4j/api/GitLabApi.java

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,10 @@ public String getApiNamespace() {
5252

5353

5454
/**
55-
* Logs into GitLab using provided {@code username} and {@code password}, and creates a new {@code GitLabApi} instance
56-
* using returned private token and the specified GitLab API version.
55+
* <p>Logs into GitLab using provided {@code username} and {@code password}, and creates a new {@code GitLabApi} instance
56+
* using returned private token and the specified GitLab API version.</p>
57+
*
58+
* NOTE: This functionality is not available on GitLab servers 10.2 and above.
5759
*
5860
* @param apiVersion the ApiVersion specifying which version of the API to use
5961
* @param url GitLab URL
@@ -67,8 +69,10 @@ public static GitLabApi login(ApiVersion apiVersion, String url, String username
6769
}
6870

6971
/**
70-
* Logs into GitLab using provided {@code username} and {@code password}, and creates a new {@code GitLabApi} instance
71-
* using returned private token using GitLab API version 4.
72+
* <p>Logs into GitLab using provided {@code username} and {@code password}, and creates a new {@code GitLabApi} instance
73+
* using returned private token using GitLab API version 4.</p>
74+
*
75+
* NOTE: This functionality is not available on GitLab servers 10.2 and above.
7276
*
7377
* @param url GitLab URL
7478
* @param username user name for which private token should be obtained
@@ -81,8 +85,10 @@ public static GitLabApi login(String url, String username, String password) thro
8185
}
8286

8387
/**
84-
* Logs into GitLab using provided {@code username} and {@code password}, and creates a new {@code GitLabApi} instance
85-
* using returned private token and the specified GitLab API version.
88+
* <p>Logs into GitLab using provided {@code username} and {@code password}, and creates a new {@code GitLabApi} instance
89+
* using returned private token and the specified GitLab API version.</p>
90+
*
91+
* NOTE: This functionality is not available on GitLab servers 10.2 and above.
8692
*
8793
* @param apiVersion the ApiVersion specifying which version of the API to use
8894
* @param url GitLab URL
@@ -111,8 +117,10 @@ public static GitLabApi login(ApiVersion apiVersion, String url, String username
111117
}
112118

113119
/**
114-
* Logs into GitLab using provided {@code username} and {@code password}, and creates a new {@code GitLabApi} instance
115-
* using returned private token using GitLab API version 4.
120+
* <p>Logs into GitLab using provided {@code username} and {@code password}, and creates a new {@code GitLabApi} instance
121+
* using returned private token using GitLab API version 4.</p>
122+
*
123+
* NOTE: This functionality is not available on GitLab servers 10.2 and above.
116124
*
117125
* @param url GitLab URL
118126
* @param username user name for which private token should be obtained
@@ -126,8 +134,10 @@ public static GitLabApi login(String url, String username, String password, bool
126134
}
127135

128136
/**
129-
* Logs into GitLab using provided {@code username} and {@code password}, and creates a new {@code GitLabApi} instance
130-
* using returned private token and specified GitLab API version.
137+
* <p>Logs into GitLab using provided {@code username} and {@code password}, and creates a new {@code GitLabApi} instance
138+
* using returned private token and specified GitLab API version.</p>
139+
*
140+
* NOTE: This functionality is not available on GitLab servers 10.2 and above.
131141
*
132142
* @param url GitLab URL
133143
* @param username user name for which private token should be obtained

src/main/java/org/gitlab4j/api/SessionApi.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public SessionApi(GitLabApi gitLabApi) {
1515
}
1616

1717
/**
18-
* Login to get private token.
18+
* Login to get private token. This functionality is not available on GitLab servers 10.2 and above.
1919
*
2020
* POST /session
2121
*

0 commit comments

Comments
 (0)