zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2025-12-05 23:06:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update organizations-related GetAllForUser method docs to make it clear that only public memberships are returned (#2487)

Browse Source
This commit is contained in:
Tim Rogers
2022-07-15 20:32:39 +01:00
committed by GitHub
parent ab1331a5a2
commit d32c9a432c
2 changed files with 24 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
Octokit/Clients/IOrganizationsClient.cs
View File

@@ -65,19 +65,27 @@ namespace Octokit
Task<IReadOnlyList<Organization>> GetAllForCurrent(ApiOptions options);
/// <summary>
/// Returns all <see cref="Organization" />s for the specified user.
/// Returns <see cref="Organization" />s which the specified user is a member of,
/// where the user hasn't marked their membership as private.
/// </summary>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>A list of the specified user's <see cref="Organization"/>s.</returns>
/// <returns>
/// A list of the <see cref="Organization"/>s which the specified user is a member
/// of, where they haven't marked their membership as private
/// </returns>
Task<IReadOnlyList<Organization>> GetAllForUser(string user);
/// <summary>
/// Returns all <see cref="Organization" />s for the specified user.
/// Returns <see cref="Organization" />s which the specified user is a member of,
/// where the user hasn't marked their membership as private.
/// </summary>
/// <param name="user">The login of the user</param>
/// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>A list of the specified user's <see cref="Organization"/>s.</returns>
/// <returns>
/// A list of the <see cref="Organization"/>s which the specified user is a member
/// of, where they haven't marked their membership as private
/// </returns>
Task<IReadOnlyList<Organization>> GetAllForUser(string user, ApiOptions options);
/// <summary>

16
Octokit/Clients/OrganizationsClient.cs
View File

@@ -85,11 +85,15 @@ namespace Octokit
}
/// <summary>
/// Returns all <see cref="Organization" />s for the specified user.
/// Returns <see cref="Organization" />s which the specified user is a member of,
/// where the user hasn't marked their membership as private.
/// </summary>
/// <param name="user">The login of the user</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>A list of the specified user's <see cref="Organization"/>s.</returns>
/// <returns>
/// A list of the <see cref="Organization"/>s which the specified user is a member
/// of, where they haven't marked their membership as private
/// </returns>
[ManualRoute("GET", "/users/{username}/orgs")]
public Task<IReadOnlyList<Organization>> GetAllForUser(string user)
{
@@ -99,12 +103,16 @@ namespace Octokit
}
/// <summary>
/// Returns all <see cref="Organization" />s for the specified user.
/// Returns <see cref="Organization" />s which the specified user is a member of,
/// where the user hasn't marked their membership as private.
/// </summary>
/// <param name="user">The login of the user</param>
/// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>A list of the specified user's <see cref="Organization"/>s.</returns>
/// <returns>
/// A list of the <see cref="Organization"/>s which the specified user is a member
/// of, where they haven't marked their membership as private
/// </returns>
[ManualRoute("GET", "/users/{username}/orgs")]
public Task<IReadOnlyList<Organization>> GetAllForUser(string user, ApiOptions options)
{