Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
Target branch: Please verify that the pull request targets the dev branch.
Description: Provide a concise description of the changes made in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Have you written and run sufficient tests to validate the changes?
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
BREAKING CHANGE: Significant changes that may affect compatibility
build: Changes that affect the build system or external dependencies
ci: Changes to our continuous integration processes or workflows
chore: Refactor, cleanup, or other non-functional code changes
docs: Documentation update or addition
feat: Introduces a new feature or enhancement to the codebase
fix: Bug fix or error correction
i18n: Internationalization or localization changes
perf: Performance improvement
refactor: Code restructuring for better maintainability, readability, or scalability
style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
test: Adding missing tests or correcting existing tests
WIP: Work in progress, a temporary label for incomplete or ongoing work
Changelog Entry
Description
This PR implements backend pagination to /admin/users. Previously, the old /users is used to return all available users which may cause the performance problem in a huge database.
The goal is to reduce the workload of the backend when there is the large number of users.
Added
Added the handle for /users to be able to receive page parameter which used to indicate the page of the users. For example, /users/?page=1&limit=10.
Added the handle for /users to be able to receive q parameter which used to query for the user. For example, /users/?q="".
Changed
Modified the related files to be able to receive page and q when calling /users.
Modified User.svelte to forward a number of users instead of the whole data of users.
Modified search function in userList.svetle to call /users/?q="" instead of filtering for the users inside the page.
Deprecated
None
Removed
None
Fixed
None
Security
None
Breaking Changes
BREAKING CHANGE: None
Additional Information
None
Screenshots or Videos
None
Contributor License Agreement
By submitting this pull request, I confirm that I have read and fully agree to the CONTRIBUTOR_LICENSE_AGREEMENT, and I am providing my contributions under its terms.
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.
## 📋 Pull Request Information
**Original PR:** https://github.com/open-webui/open-webui/pull/13135
**Author:** [@AnapatChaiwongse](https://github.com/AnapatChaiwongse)
**Created:** 4/22/2025
**Status:** ❌ Closed
**Base:** `dev` ← **Head:** `dev`
---
### 📝 Commits (5)
- [`4bd941d`](https://github.com/open-webui/open-webui/commit/4bd941d7099f123344f18b25bc818227a7a6932a) Update UserList.svelte
- [`a6ad5e3`](https://github.com/open-webui/open-webui/commit/a6ad5e3bbf503799478aa78149c1fd2432a1a7ea) Update users.py
- [`3f8874a`](https://github.com/open-webui/open-webui/commit/3f8874ae623f1c4e3f775c93baf0554490e9f628) Update users.py
- [`1d3ebcb`](https://github.com/open-webui/open-webui/commit/1d3ebcb9968d3a1b8809098fbb9be365e78f3e43) Update index.ts
- [`577dee5`](https://github.com/open-webui/open-webui/commit/577dee53c31499837c43880405fafdef3401d8b9) Update Users.svelte
### 📊 Changes
**5 files changed** (+117 additions, -71 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/open_webui/models/users.py` (+17 -2)
📝 `backend/open_webui/routers/users.py` (+12 -3)
📝 `src/lib/apis/users/index.ts` (+53 -19)
📝 `src/lib/components/admin/Users.svelte` (+3 -1)
📝 `src/lib/components/admin/Users/UserList.svelte` (+32 -46)
</details>
### 📄 Description
# Pull Request Checklist
### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) and describe your changes before submitting a pull request.
**Before submitting, make sure you've checked the following:**
- [x] **Target branch:** Please verify that the pull request targets the `dev` branch.
- [x] **Description:** Provide a concise description of the changes made in this pull request.
- [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description.
- [ ] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources?
- [ ] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
- [x] **Testing:** Have you written and run sufficient tests to validate the changes?
- [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
- [x] **Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following:
- **BREAKING CHANGE**: Significant changes that may affect compatibility
- **build**: Changes that affect the build system or external dependencies
- **ci**: Changes to our continuous integration processes or workflows
- **chore**: Refactor, cleanup, or other non-functional code changes
- **docs**: Documentation update or addition
- **feat**: Introduces a new feature or enhancement to the codebase
- **fix**: Bug fix or error correction
- **i18n**: Internationalization or localization changes
- **perf**: Performance improvement
- **refactor**: Code restructuring for better maintainability, readability, or scalability
- **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
- **test**: Adding missing tests or correcting existing tests
- **WIP**: Work in progress, a temporary label for incomplete or ongoing work
# Changelog Entry
### Description
- This PR implements backend pagination to `/admin/users`. Previously, the old `/users` is used to return all available users which may cause the performance problem in a huge database.
- The goal is to reduce the workload of the backend when there is the large number of users.
### Added
- Added the handle for `/users` to be able to receive `page` parameter which used to indicate the page of the users. For example, `/users/?page=1&limit=10`.
- Added the handle for `/users` to be able to receive `q` parameter which used to query for the user. For example, `/users/?q=""`.
### Changed
- Modified the related files to be able to receive `page` and `q` when calling `/users`.
- Modified `User.svelte` to forward a number of users instead of the whole data of users.
- Modified search function in `userList.svetle` to call `/users/?q=""` instead of filtering for the users inside the page.
### Deprecated
- None
### Removed
- None
### Fixed
- None
### Security
- None
### Breaking Changes
- **BREAKING CHANGE**: None
---
### Additional Information
- None
### Screenshots or Videos
- None
### Contributor License Agreement
By submitting this pull request, I confirm that I have read and fully agree to the [CONTRIBUTOR_LICENSE_AGREEMENT](CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms.
---
<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/13135
Author: @AnapatChaiwongse
Created: 4/22/2025
Status: ❌ Closed
Base:
dev← Head:dev📝 Commits (5)
4bd941dUpdate UserList.sveltea6ad5e3Update users.py3f8874aUpdate users.py1d3ebcbUpdate index.ts577dee5Update Users.svelte📊 Changes
5 files changed (+117 additions, -71 deletions)
View changed files
📝
backend/open_webui/models/users.py(+17 -2)📝
backend/open_webui/routers/users.py(+12 -3)📝
src/lib/apis/users/index.ts(+53 -19)📝
src/lib/components/admin/Users.svelte(+3 -1)📝
src/lib/components/admin/Users/UserList.svelte(+32 -46)📄 Description
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
devbranch.Changelog Entry
Description
/admin/users. Previously, the old/usersis used to return all available users which may cause the performance problem in a huge database.Added
/usersto be able to receivepageparameter which used to indicate the page of the users. For example,/users/?page=1&limit=10./usersto be able to receiveqparameter which used to query for the user. For example,/users/?q="".Changed
pageandqwhen calling/users.User.svelteto forward a number of users instead of the whole data of users.userList.svetleto call/users/?q=""instead of filtering for the users inside the page.Deprecated
Removed
Fixed
Security
Breaking Changes
Additional Information
Screenshots or Videos
Contributor License Agreement
By submitting this pull request, I confirm that I have read and fully agree to the CONTRIBUTOR_LICENSE_AGREEMENT, and I am providing my contributions under its terms.
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.