diff --git a/.changeset/olive-bags-glow.md b/.changeset/olive-bags-glow.md new file mode 100644 index 0000000000..2fae30cffe --- /dev/null +++ b/.changeset/olive-bags-glow.md @@ -0,0 +1,5 @@ +--- +"@medusajs/medusa": patch +--- + +fix(medusa): Update list return type of `GET /admin/users`. diff --git a/packages/generated/client-types/src/lib/models/AdminUsersListRes.ts b/packages/generated/client-types/src/lib/models/AdminUsersListRes.ts index 4b182bd4b8..b1dca7d39d 100644 --- a/packages/generated/client-types/src/lib/models/AdminUsersListRes.ts +++ b/packages/generated/client-types/src/lib/models/AdminUsersListRes.ts @@ -13,4 +13,16 @@ export interface AdminUsersListRes { * An array of users details. */ users: Array + /** + * The total number of items available + */ + count: number + /** + * The number of users skipped when retrieving the users. + */ + offset: number + /** + * The number of items per page + */ + limit: number } diff --git a/packages/medusa/src/api/routes/admin/users/index.ts b/packages/medusa/src/api/routes/admin/users/index.ts index d84f22bff3..0b62eb6c49 100644 --- a/packages/medusa/src/api/routes/admin/users/index.ts +++ b/packages/medusa/src/api/routes/admin/users/index.ts @@ -1,3 +1,4 @@ +import { PaginatedResponse } from "@medusajs/types" import { Router } from "express" import { User } from "../../../../models/user" import { DeleteResponse } from "../../../../types/common" @@ -77,14 +78,26 @@ export type AdminUserRes = { * description: "The list of users." * required: * - users + * - count + * - offset + * - limit * properties: * users: * type: array * description: "An array of users details." * items: * $ref: "#/components/schemas/User" + * count: + * type: integer + * description: The total number of items available + * offset: + * type: integer + * description: The number of users skipped when retrieving the users. + * limit: + * type: integer + * description: The number of items per page */ -export type AdminUsersListRes = { +export type AdminUsersListRes = PaginatedResponse & { users: Omit[] }