fix(utils): disallow schema type array value string by lukaszzazulak · Pull Request #10691 · swagger-api/swagger-ui

lukaszzazulak · 2026-01-28T11:55:09Z

Add validation and show error if the schema type is an array and value provided is string

Description

Before swagger-api/swagger-js#3826, it was possible to send request without any issues. Now validation and error has been added

Motivation and Context

After swagger-api/swagger-js#3826 has been introduced, when user tries to Execute a request, the loader appears and stays

How Has This Been Tested?

Manually and unit test

Types of changes

No code changes (changes to documentation, CI, metadata, etc)
Dependency changes (any modification to dependencies in package.json)
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.

Copilot

Pull request overview

This PR removes support for string values when the schema type is "array", adding validation to reject such cases. Previously, the code allowed array-type parameters to accept string values, which caused issues after PR #3826 was introduced where requests would hang indefinitely.

Changes:

Removed arrayStringCheck validation that allowed string values for array-type schemas
Updated test expectations to verify that string values for array types now produce validation errors

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
src/core/utils/index.js	Removed the `arrayStringCheck` condition that allowed strings as valid values for array-type schemas
test/unit/core/utils.js	Updated test assertion to expect a validation error when a string is provided for an array-type parameter

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

test/unit/core/utils.js

robert-hebel-sb · 2026-01-29T10:25:14Z

LGTM 💅

but let's add E2E test in test/e2e-cypress/e2e/bugs to ensure the fix works for the following spec

openapi: 3.0.3
info:
    title: test
    version: 1.0.0
paths:
    /test:
        get:
            parameters:
                - in: query
                  name: test
                  required: true
                  schema:
                    type: array
                    example: 'test1'
                    items:
                        type: string
                        enum:
                            - 'test1'
                            - 'test2'
                            - 'test3'
            responses:
                default:
                    description: ok

lukaszzazulak · 2026-01-29T18:19:50Z

@robert-hebel-sb added e2e test

glowcloud

I wonder if there are any cases where we could input an actual string when the type is array. I think it could be possible with request body but we might not be using the same validation there. But I'm fine with this solution for now, we'll see if there are any issues with it.

Perhaps in the future we could change the mechanism for generating examples, so that it does not use examples/default values that are not of the provided type.

glowcloud · 2026-01-30T06:55:23Z

test/e2e-cypress/e2e/features/try-it-out-schema-type-array-example-type-string.cy.js

@@ -0,0 +1,12 @@
+describe.only("Try it out with schema type array but example type string", () => {


Suggested change

describe.only("Try it out with schema type array but example type string", () => {

describe("Try it out with schema type array but example type string", () => {

Also we can add this at the top of the file to enable linting for it - we need to do this manually in Swagger UI for new/refactored files, as we do not have it enabled for the entire repo.

/** * @prettier */

…e-string

hakornyutt-create · 2026-02-01T17:16:35Z

fix(utils)-disallow-schema-type-array-value-string

This reverts commit e87ecd7.

…#10710) This reverts commit e87ecd7.

## [5.31.1](v5.31.0...v5.31.1) (2026-02-16) ### Bug Fixes * **deps:** align the tree-sitter version ([#10694](#10694)) ([6453290](6453290)) * **deps:** update vulnerable dependencies ([#10725](#10725)) ([23d6c26](23d6c26)) * **utils:** disallow schema type array value string ([#10691](#10691)) ([e87ecd7](e87ecd7)) * validated support for OpenAPI 3.1.2 and updated docs ([8bf8ed9](8bf8ed9)) ### Reverts * Revert "fix(utils): disallow schema type array value string ([#10691](#10691))" ([#10710](#10710)) ([0a7ff5b](0a7ff5b))

swagger-bot · 2026-02-16T12:59:48Z

🎉 This PR is included in version 5.31.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

* fix(utils): disallow schema type array value string

…api#10691)" (swagger-api#10710) This reverts commit e87ecd7.

## [5.31.1](swagger-api/swagger-ui@v5.31.0...v5.31.1) (2026-02-16) ### Bug Fixes * **deps:** align the tree-sitter version ([swagger-api#10694](swagger-api#10694)) ([6453290](swagger-api@6453290)) * **deps:** update vulnerable dependencies ([swagger-api#10725](swagger-api#10725)) ([23d6c26](swagger-api@23d6c26)) * **utils:** disallow schema type array value string ([swagger-api#10691](swagger-api#10691)) ([e87ecd7](swagger-api@e87ecd7)) * validated support for OpenAPI 3.1.2 and updated docs ([8bf8ed9](swagger-api@8bf8ed9)) ### Reverts * Revert "fix(utils): disallow schema type array value string ([swagger-api#10691](swagger-api#10691))" ([swagger-api#10710](swagger-api#10710)) ([0a7ff5b](swagger-api@0a7ff5b))

fix(utils): disallow schema type array value string

0df0dfb

lukaszzazulak requested a review from Copilot January 28, 2026 12:00

Copilot AI reviewed Jan 28, 2026

View reviewed changes

test/unit/core/utils.js Show resolved Hide resolved

fix(utils): disallow schema type array value string

c40390e

glowcloud approved these changes Jan 30, 2026

View reviewed changes

fix(utils): disallow schema type array value string

4c293c1

robert-hebel-sb approved these changes Jan 30, 2026

View reviewed changes

Merge branch 'master' into fix(utils)-disallow-schema-type-array-valu…

ee7cadd

…e-string

lukaszzazulak merged commit e87ecd7 into master Jan 30, 2026
9 checks passed

lukaszzazulak added a commit that referenced this pull request Feb 4, 2026

Revert "fix(utils): disallow schema type array value string (#10691)"

48c9ec1

This reverts commit e87ecd7.

lukaszzazulak mentioned this pull request Feb 4, 2026

Revert "fix(utils): disallow schema type array value string" #10710

Merged

lukaszzazulak added a commit that referenced this pull request Feb 4, 2026

Revert "fix(utils): disallow schema type array value string (#10691)" (…

0a7ff5b

…#10710) This reverts commit e87ecd7.

swagger-bot added the released label Feb 16, 2026

delendik-testops pushed a commit to ModiusOpenData/swagger-ui that referenced this pull request Mar 3, 2026

fix(utils): disallow schema type array value string (swagger-api#10691)

bb2bac5

* fix(utils): disallow schema type array value string

delendik-testops pushed a commit to ModiusOpenData/swagger-ui that referenced this pull request Mar 3, 2026

Revert "fix(utils): disallow schema type array value string (swagger-…

54b6732

…api#10691)" (swagger-api#10710) This reverts commit e87ecd7.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(utils): disallow schema type array value string#10691

fix(utils): disallow schema type array value string#10691
lukaszzazulak merged 4 commits intomasterfrom
fix(utils)-disallow-schema-type-array-value-string

lukaszzazulak commented Jan 28, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

robert-hebel-sb commented Jan 29, 2026

Uh oh!

lukaszzazulak commented Jan 29, 2026

Uh oh!

glowcloud left a comment

Uh oh!

glowcloud Jan 30, 2026

Uh oh!

Uh oh!

hakornyutt-create commented Feb 1, 2026

Uh oh!

swagger-bot commented Feb 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

		@@ -0,0 +1,12 @@
		describe.only("Try it out with schema type array but example type string", () => {

	describe.only("Try it out with schema type array but example type string", () => {
	describe("Try it out with schema type array but example type string", () => {

Conversation

lukaszzazulak commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

robert-hebel-sb commented Jan 29, 2026

Uh oh!

lukaszzazulak commented Jan 29, 2026

Uh oh!

glowcloud left a comment

Choose a reason for hiding this comment

Uh oh!

glowcloud Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hakornyutt-create commented Feb 1, 2026

Uh oh!

swagger-bot commented Feb 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

lukaszzazulak commented Jan 28, 2026 •

edited

Loading