github-starred/open-webui
2
0
Fork 0
mirror of https://github.com/open-webui/open-webui.git synced 2026-03-22 06:02:06 -05:00
Code Issues 308 Packages Projects Releases 100 Wiki Activity

[PR #7905] [MERGED] feat: make swagger docs available offline #8926

New Issue
Closed
opened 2025-11-11 18:09:43 -06:00 by GiteaMirror · 0 comments
GiteaMirror commented 2025-11-11 18:09:43 -06:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/7905
Author: @devdev999
Created: 12/17/2024
Status: ✅ Merged
Merged: 12/17/2024
Merged by: @tjbck

Base: dev ← Head: make-swagger-available-offline

📝 Commits (2)

  • ab8f8bc feat: add offline swagger docs
  • d681357 fix: update swagger-ui version to latest release 5.18.2

📊 Changes

4 files changed (+16 additions, -0 deletions)

View changed files

📝 backend/open_webui/main.py (+11 -0)
➕ backend/open_webui/static/swagger-ui/favicon.png (+0 -0)
➕ backend/open_webui/static/swagger-ui/swagger-ui-bundle.js (+2 -0)
➕ backend/open_webui/static/swagger-ui/swagger-ui.css (+3 -0)

📄 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:

  • 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 for validating 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 cleary 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

  • Enable viewing of swagger docs in a fully offline environment

Added

Additional Information

The swagger-ui CDN files are actually being fetched by the client accessing the docs. If the client has internet access, then the swagger docs UI can actually be loaded even though the open-webui container does not have internet access.
This PR adds the required files from the CDN inside the static folder so that swagger docs will be served from the static folder instead, by using the monkey patch code from https://github.com/fastapi/fastapi/discussions/8500#discussioncomment-5152408.
This PR is meant to be a first-cut to make this available to all who have been asking about it in issues like #5714. Ideally the swagger-ui files should be automatically downloaded as part of the build process, but that can be for a future PR.

Screenshots or Videos

Before:
image

After:
image

🔄 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/7905 **Author:** [@devdev999](https://github.com/devdev999) **Created:** 12/17/2024 **Status:** ✅ Merged **Merged:** 12/17/2024 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `make-swagger-available-offline` --- ### 📝 Commits (2) - [`ab8f8bc`](https://github.com/open-webui/open-webui/commit/ab8f8bcf92adccee310b61960b5441c2a05e2cd1) feat: add offline swagger docs - [`d681357`](https://github.com/open-webui/open-webui/commit/d681357c0cf9ada59bbdc887bd8932f227d1eaf3) fix: update swagger-ui version to latest release 5.18.2 ### 📊 Changes **4 files changed** (+16 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/main.py` (+11 -0) ➕ `backend/open_webui/static/swagger-ui/favicon.png` (+0 -0) ➕ `backend/open_webui/static/swagger-ui/swagger-ui-bundle.js` (+2 -0) ➕ `backend/open_webui/static/swagger-ui/swagger-ui.css` (+3 -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) 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? - [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [x] **Testing:** Have you written and run sufficient tests for validating 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 cleary 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 - Enable viewing of swagger docs in a fully offline environment ### Added - swagger-ui files downloaded from https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.18.2/swagger-ui-bundle.js and https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.18.2/swagger-ui.css - fastapi favicon downloaded from https://fastapi.tiangolo.com/img/favicon.png - monkey patch code from https://github.com/fastapi/fastapi/discussions/8500#discussioncomment-5152408 --- ### Additional Information The swagger-ui CDN files are actually being fetched by the client accessing the docs. If the client has internet access, then the swagger docs UI can actually be loaded even though the open-webui container does not have internet access. This PR adds the required files from the CDN inside the static folder so that swagger docs will be served from the static folder instead, by using the monkey patch code from https://github.com/fastapi/fastapi/discussions/8500#discussioncomment-5152408. This PR is meant to be a first-cut to make this available to all who have been asking about it in issues like #5714. Ideally the swagger-ui files should be automatically downloaded as part of the build process, but that can be for a future PR. ### Screenshots or Videos Before: ![image](https://github.com/user-attachments/assets/1912aa7d-57a2-4da8-9fc8-7d652b993f12) After: ![image](https://github.com/user-attachments/assets/82a6d042-91d7-4673-8a23-3c88a3fc8a92) --- <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 2025-11-11 18:09:43 -06:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
core
documentation
enhancement
good first issue
help wanted
non-core
pull-request
Mirrored from GitHub Pull Request
 python
question
testing wanted
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#8926
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?