[PR #24942] feat: add Web Search warning as banner and toast message #131605

New Issue

GiteaMirror · 2026-05-21T17:18:37-05:00

GiteaMirror commented

2026-05-21 17:18:37 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/24942
Author: @michelledkfz
Created: 5/20/2026
Status: 🔄 Open

Base: dev ← Head: feature/WebSearch-Warning

📝 Commits (1)

4a9d7ef feat: add Web Search warning as banner and toast message

📊 Changes

5 files changed (+77 additions, -1 deletions)

View changed files

📝 backend/open_webui/config.py (+6 -1)
📝 backend/open_webui/main.py (+3 -0)
📝 backend/open_webui/routers/retrieval.py (+4 -0)
📝 src/lib/components/admin/Settings/WebSearch.svelte (+16 -0)
📝 src/lib/components/chat/MessageInput.svelte (+48 -0)

📄 Description

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request.

This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR.

Before submitting, make sure you've checked the following:

Linked Issue/Discussion: This PR references an existing Discussion — Closes #___ / Relates to #___. If one does not exist, create one first. PRs without a linked issue or discussion may be closed without review.
Target branch: Verify that the pull request targets the dev branch. PRs targeting main will be immediately closed.
Description: Provide a concise description of the changes made in this pull request down below.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Add docs in Open WebUI Docs Repository. Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps.
Dependencies: Are there any new or upgraded dependencies? If so, explain why, update the changelog/docs, and include any compatibility notes. Actually run the code/function that uses updated library to ensure it doesn't crash.
Testing: Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Include reproducible steps to demonstrate the issue before the fix. Test edge cases (URL encoding, HTML entities, types). Take this as an opportunity to make screenshots of the feature/fix and include them in the PR description.
Agentic AI Code: Confirm this Pull Request is not written by any AI Agent or has at least gone through additional human review AND manual testing. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR.
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?
Design & Architecture: Prefer smart defaults over adding new settings; use local state for ephemeral UI logic. Open a Discussion for major architectural or UX changes.
Git Hygiene: Keep PRs atomic (one logical change). Clean up commits and rebase on dev to ensure no unrelated commits (e.g. from main) are included. Push updates to the existing PR branch instead of closing and reopening.
Title 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

Show yellow dismissible banner while web search is active
Show one-time toast when web search is toggled on
Both are suppressed when the admin disables the toggle
motivation: In managed or regulated deployments, administrators may need to make it clear to users when a prompt or generated web query may be sent to the configured Web Search provider. https://github.com/open-webui/open-webui/discussions/24772

Added

WEB_SEARCH_WARNING_ENABLED ConfigVar in backend/open_webui/config.py (default: false, configurable via env var or persisted DB value)
Admin UI toggle "Show Web Search Warning" in src/lib/components/admin/Settings/WebSearch.svelte with a tooltip explaining the behaviour
Yellow dismissible banner in src/lib/components/chat/MessageInput.svelte shown while web search is active and the warning toggle is enabled
One-time toast notification when web search is toggled on (4 s, top‑right)
Both banner and toast read the flag from $config?.features with a snake_case fallback for compatibility

Changed

backend/open_webui/main.py — register the new config var and expose it via the public config endpoint (key web_search_warning_enabled)
backend/open_webui/routers/retrieval.py — add the field to the WebConfig model, the GET response, and the POST update handler
src/lib/components/admin/Settings/WebSearch.svelte — add the toggle UI with switch and tooltip
src/lib/components/chat/MessageInput.svelte — implement banner ({#if showWebSearchWarning} template block) and toast ($: reactive block)

Additional Information

https://github.com/open-webui/open-webui/discussions/24772

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.

Note

Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in.

_{🔄 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/24942 **Author:** [@michelledkfz](https://github.com/michelledkfz) **Created:** 5/20/2026 **Status:** 🔄 Open **Base:** `dev` ← **Head:** `feature/WebSearch-Warning` --- ### 📝 Commits (1) - [`4a9d7ef`](https://github.com/open-webui/open-webui/commit/4a9d7ef7010f7ed59dc4bcb555d03f9eb0b1c8e4) feat: add Web Search warning as banner and toast message ### 📊 Changes **5 files changed** (+77 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/config.py` (+6 -1) 📝 `backend/open_webui/main.py` (+3 -0) 📝 `backend/open_webui/routers/retrieval.py` (+4 -0) 📝 `src/lib/components/admin/Settings/WebSearch.svelte` (+16 -0) 📝 `src/lib/components/chat/MessageInput.svelte` (+48 -0) </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) to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request. This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR.  **Before submitting, make sure you've checked the following:** - [x] **Linked Issue/Discussion:** This PR references an existing [Discussion](https://github.com/open-webui/open-webui/discussions/24772) — `Closes #___` / `Relates to #___`. If one does not exist, create one first. PRs without a linked issue or discussion may be closed without review. - [x] **Target branch:** Verify that the pull request targets the `dev` branch. **PRs targeting `main` will be immediately closed.** - [x] **Description:** Provide a concise description of the changes made in this pull request down below. - [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. - [x] **Documentation:** Add docs in [Open WebUI Docs Repository](https://github.com/open-webui/docs). Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps. - [x] **Dependencies:** Are there any new or upgraded dependencies? If so, explain why, update the changelog/docs, and include any compatibility notes. Actually run the code/function that uses updated library to ensure it doesn't crash. - [x] **Testing:** Perform manual tests to **verify the implemented fix/feature works as intended AND does not break any other functionality**. Include reproducible steps to demonstrate the issue before the fix. Test edge cases (URL encoding, HTML entities, types). Take this as an opportunity to **make screenshots of the feature/fix and include them in the PR description**. - [x] **Agentic AI Code:** Confirm this Pull Request is **not written by any AI Agent** or has at least **gone through additional human review AND manual testing**. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR. - [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] **Design & Architecture:** Prefer smart defaults over adding new settings; use local state for ephemeral UI logic. Open a Discussion for major architectural or UX changes. - [x] **Git Hygiene:** Keep PRs atomic (one logical change). Clean up commits and rebase on `dev` to ensure no unrelated commits (e.g. from `main`) are included. Push updates to the existing PR branch instead of closing and reopening. - [x] **Title 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 - Show yellow dismissible banner while web search is active - Show one-time toast when web search is toggled on - Both are suppressed when the admin disables the toggle - motivation: In managed or regulated deployments, administrators may need to make it clear to users when a prompt or generated web query may be sent to the configured Web Search provider. https://github.com/open-webui/open-webui/discussions/24772 ### Added - WEB_SEARCH_WARNING_ENABLED ConfigVar in backend/open_webui/config.py (default: false, configurable via env var or persisted DB value) - Admin UI toggle "Show Web Search Warning" in src/lib/components/admin/Settings/WebSearch.svelte with a tooltip explaining the behaviour - Yellow dismissible banner in src/lib/components/chat/MessageInput.svelte shown while web search is active and the warning toggle is enabled - One-time toast notification when web search is toggled on (4 s, top‑right) - Both banner and toast read the flag from $config?.features with a snake_case fallback for compatibility ### Changed - backend/open_webui/main.py — register the new config var and expose it via the public config endpoint (key web_search_warning_enabled) - backend/open_webui/routers/retrieval.py — add the field to the WebConfig model, the GET response, and the POST update handler - src/lib/components/admin/Settings/WebSearch.svelte — add the toggle UI with switch and tooltip - src/lib/components/chat/MessageInput.svelte — implement banner ({#if showWebSearchWarning} template block) and toast ($: reactive block) --- ### Additional Information https://github.com/open-webui/open-webui/discussions/24772 ### Contributor License Agreement  - [x] By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](https://github.com/open-webui/open-webui/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. > [!NOTE] > Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2026-05-21 17:18:37 -05:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/open-webui#131605