Skip to content

Commit e7d0fc1

Browse files
committed
fix: fixed wrong JavaDoc
1 parent f8f81bb commit e7d0fc1

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

gitlab4j-api/src/main/java/org/gitlab4j/api/GroupApi.java

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -597,28 +597,30 @@ public Stream<Project> getProjectsStream(Object groupIdOrPath) throws GitLabApiE
597597
}
598598

599599
/**
600-
* Get a list of projects belonging to the specified group ID and filter.
600+
* Get a list of groups where the given group has been invited.
601+
* When accessed without authentication, only public shared groups are returned.
601602
*
602-
* <pre><code>GitLab Endpoint: GET /groups/:id/projects</code></pre>
603+
* <pre><code>GitLab Endpoint: GET /groups/:id/groups/shared</code></pre>
603604
*
604605
* @param groupIdOrPath the group ID, path of the group, or a Group instance holding the group ID or path
605-
* @param filter the GroupProjectsFilter instance holding the filter values for the query
606-
* @return a List containing Project instances that belong to the group and match the provided filter
606+
* @param filter the SharedGroupsFilter instance holding the filter values for the query
607+
* @return a List containing the Group instances the given group has been invited to and match the provided filter
607608
* @throws GitLabApiException if any exception occurs
608609
*/
609610
public List<Group> getSharedGroups(Object groupIdOrPath, SharedGroupsFilter filter) throws GitLabApiException {
610611
return (getSharedGroups(groupIdOrPath, filter, getDefaultPerPage()).all());
611612
}
612613

613614
/**
614-
* Get a Pager of projects belonging to the specified group ID and filter.
615+
* Get a Pager of groups where the given group has been invited.
616+
* When accessed without authentication, only public shared groups are returned.
615617
*
616-
* <pre><code>GitLab Endpoint: GET /groups/:id/projects</code></pre>
618+
* <pre><code>GitLab Endpoint: GET /groups/:id/groups/shared</code></pre>
617619
*
618620
* @param groupIdOrPath the group ID, path of the group, or a Group instance holding the group ID or path
619-
* @param filter the GroupProjectsFilter instance holding the filter values for the query
620-
* @param itemsPerPage the number of Project instances that will be fetched per page
621-
* @return a Pager containing Project instances that belong to the group and match the provided filter
621+
* @param filter the SharedGroupsFilter instance holding the filter values for the query
622+
* @param itemsPerPage the number of Group instances that will be fetched per page
623+
* @return a Pager containing the Group instances the given group has been invited to and match the provided filter
622624
* @throws GitLabApiException if any exception occurs
623625
*/
624626
public Pager<Group> getSharedGroups(Object groupIdOrPath, SharedGroupsFilter filter, int itemsPerPage)
@@ -636,14 +638,14 @@ public Pager<Group> getSharedGroups(Object groupIdOrPath, SharedGroupsFilter fil
636638
}
637639

638640
/**
639-
* Get a list of groups where the given group has been invited.
641+
* Get a Stream of groups where the given group has been invited.
640642
* When accessed without authentication, only public shared groups are returned.
641643
*
642644
* <pre><code>GitLab Endpoint: GET /groups/:id/groups/shared</code></pre>
643645
*
644646
* @param groupIdOrPath the group ID, path of the group, or a Group instance holding the group ID or path
645-
* @param filter the GroupProjectsFilter instance holding the filter values for the query
646-
* @return a Stream containing the Group instances that belong to the group and match the provided filter
647+
* @param filter the SharedGroupsFilter instance holding the filter values for the query
648+
* @return a Stream containing the Group instances the given group has been invited to and match the provided filter
647649
* @throws GitLabApiException if any exception occurs
648650
*/
649651
public Stream<Group> getSharedGroupsStream(Object groupIdOrPath, SharedGroupsFilter filter)

0 commit comments

Comments
 (0)