[PR #12968] [MERGED] feat: support OpenAPI parameter description and enum values in tool spec #46114

New Issue

GiteaMirror · 2026-04-29T20:47:09-05:00

GiteaMirror commented

2026-04-29 20:47:09 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/12968
Author: @tremlin
Created: 4/17/2025
Status: ✅ Merged
Merged: 4/18/2025
Merged by: @tjbck

Base: dev ← Head: feat-openapi-parameter-description

📝 Commits (1)

3dcbf1a feat: support OpenAPI parameter description and enum values in tool spec

📊 Changes

2 files changed (+15 additions, -2 deletions)

View changed files

📝 backend/open_webui/utils/tools.py (+10 -1)
📝 src/lib/utils/index.ts (+5 -1)

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

Improves handling of OpenAPI spec for tool servers by considering parameter description and enum values.

Added

Improves handling of OpenAPI spec for tool servers by considering parameter description and enum values.

Changed

Deprecated

Removed

Fixed

Security

Breaking Changes

Additional Information

In the OpenAPI specs that I've come across the parameter itself has a description property whereas the schema usually does not have a description (Example: https://github.com/bump-sh-examples/train-travel-api/blob/main/openapi.yaml).
This merge request ensures that both options are taken into account when finalizing the tool server specification. Additionally, enum values are listed individually to assist the AI in utilizing the API function.

https://swagger.io/specification/#parameter-object

Here I am not sure if we should replace the text "Possible Values" with something maybe more language-neutral like "Enum". For my tests I've always used the "Possible Values".

Screenshots or Videos

_{🔄 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/12968 **Author:** [@tremlin](https://github.com/tremlin) **Created:** 4/17/2025 **Status:** ✅ Merged **Merged:** 4/18/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `feat-openapi-parameter-description` --- ### 📝 Commits (1) - [`3dcbf1a`](https://github.com/open-webui/open-webui/commit/3dcbf1acf51f9e7ec810c7388cdb58df4039f614) feat: support OpenAPI parameter description and enum values in tool spec ### 📊 Changes **2 files changed** (+15 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/utils/tools.py` (+10 -1) 📝 `src/lib/utils/index.ts` (+5 -1) </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. - [X] **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 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 - Improves handling of OpenAPI spec for tool servers by considering parameter description and enum values. ### Added - Improves handling of OpenAPI spec for tool servers by considering parameter description and enum values. ### Changed ### Deprecated ### Removed ### Fixed ### Security ### Breaking Changes --- ### Additional Information In the OpenAPI specs that I've come across the `parameter` itself has a `description` property whereas the `schema` usually does not have a description (Example: https://github.com/bump-sh-examples/train-travel-api/blob/main/openapi.yaml). This merge request ensures that both options are taken into account when finalizing the tool server specification. Additionally, `enum` values are listed individually to assist the AI in utilizing the API function. https://swagger.io/specification/#parameter-object Here I am not sure if we should replace the text "Possible Values" with something maybe more language-neutral like "Enum". For my tests I've always used the "Possible Values". ### Screenshots or Videos --- <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-04-29 20:47:09 -05:00

GiteaMirror closed this issue

2026-04-29 20:47:09 -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#46114