docs: correct list users endpoint description (#9050)

# Which Problems Are Solved

There is a wrong description on the ListUsers endpoint on the users v2
API.

# How the Problems Are Solved

Correctly rewrote it with mention of instance instead of organization.

# Additional Changes

None

# Additional Context

Closes #8961
This commit is contained in:
Stefan Benz 2024-12-13 10:33:20 +01:00 committed by GitHub
parent a077771bff
commit 0a859fe416
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 2 additions and 2 deletions

View File

@ -168,7 +168,7 @@ service UserService {
// Search Users // Search Users
// //
// Search for users. By default, we will return users of your organization. Make sure to include a limit and sorting for pagination.. // Search for users. By default, we will return all users of your instance that you have permission to read. Make sure to include a limit and sorting for pagination.
rpc ListUsers(ListUsersRequest) returns (ListUsersResponse) { rpc ListUsers(ListUsersRequest) returns (ListUsersResponse) {
option (google.api.http) = { option (google.api.http) = {
post: "/v2/users" post: "/v2/users"

View File

@ -174,7 +174,7 @@ service UserService {
// Search Users // Search Users
// //
// Search for users. By default, we will return users of your organization. Make sure to include a limit and sorting for pagination. // Search for users. By default, we will return all users of your instance that you have permission to read. Make sure to include a limit and sorting for pagination.
// //
// Deprecated: please move to the corresponding endpoint under user service v2 (GA). // Deprecated: please move to the corresponding endpoint under user service v2 (GA).
rpc ListUsers(ListUsersRequest) returns (ListUsersResponse) { rpc ListUsers(ListUsersRequest) returns (ListUsersResponse) {