[PR #16344] [MERGED] fix: include items property in OpenAPI array parameters for OpenAI function calling #47155

New Issue

GiteaMirror · 2026-04-29T22:15:11-05:00

GiteaMirror commented

2026-04-29 22:15:11 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/16344
Author: @Rain6435
Created: 8/7/2025
Status: ✅ Merged
Merged: 8/8/2025
Merged by: @tjbck

Base: dev ← Head: fix-openapi-array-parameters

📝 Commits (1)

30540cb fix: include items property in OpenAPI array parameters for OpenAI function calling

📊 Changes

1 file changed (+7 additions, -1 deletions)

View changed files

📝 backend/open_webui/utils/tools.py (+7 -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
- 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
- fix: Bug fix or error correction

Changelog Entry

Description

This PR fixes OpenAPI array parameter conversion for OpenAI function calling by
ensuring the 'items' property is included in generated function schemas.

OpenAPI specs with array query parameters were generating invalid OpenAI
function schemas
Missing 'items' property caused OpenAI to return 400 Bad Request: 'array
schema missing items'
Issue affected tool servers using array parameters like tags filtering

Fixed

Corrected the convert_openapi_to_tool_payload() function in
backend/open_webui/utils/tools.py to properly include the 'items'
property for array-type parameters. This resolves the 400 Bad Request: 'array schema missing items' error during OpenAI function calling.

Additional Information

Fixes #14115

Test Plan

Tested with exact example from issue #14115
Verified generated schema now includes required 'items' property
Syntax validation passed

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.

_{🔄 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/16344 **Author:** [@Rain6435](https://github.com/Rain6435) **Created:** 8/7/2025 **Status:** ✅ Merged **Merged:** 8/8/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `fix-openapi-array-parameters` --- ### 📝 Commits (1) - [`30540cb`](https://github.com/open-webui/open-webui/commit/30540cb40e6d3040d03a7da6dc243bcece1377c6) fix: include items property in OpenAPI array parameters for OpenAI function calling ### 📊 Changes **1 file changed** (+7 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `backend/open_webui/utils/tools.py` (+7 -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 * **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 * **fix**: Bug fix or error correction # Changelog Entry ### Description This PR fixes OpenAPI array parameter conversion for OpenAI function calling by ensuring the 'items' property is included in generated function schemas. * OpenAPI specs with array query parameters were generating invalid OpenAI function schemas * Missing 'items' property caused OpenAI to return 400 Bad Request: 'array schema missing items' * Issue affected tool servers using array parameters like tags filtering ### Fixed * Corrected the `convert_openapi_to_tool_payload()` function in `backend/open_webui/utils/tools.py` to properly include the 'items' property for array-type parameters. This resolves the `400 Bad Request: 'array schema missing items'` error during OpenAI function calling. ### Additional Information Fixes #14115 ### Test Plan * Tested with exact example from issue #14115 * Verified generated schema now includes required 'items' property * Syntax validation passed ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](/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>

GiteaMirror added the pull-request label 2026-04-29 22:15:11 -05:00

GiteaMirror closed this issue

2026-04-29 22:15:13 -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#47155