swagger-api / swagger-api/swagger-ui
deepObject query parameter does not work
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Q&A (please complete the following information)
- OS: Windows
- Browser: chrome
- Version: 131.0
- Method of installation: [e.g. npm, dist assets]
- Swagger-UI version: not sure. I am using
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.5.0</version>
<scope>runtime</scope>
</dependency>
which seems to be using Swagger UI version 5.13.0. see this
- Swagger/OpenAPI version: [e.g. Swagger 2.0, OpenAPI 3.0] openapi: 3.0.1
Content & configuration
Example Swagger/OpenAPI definition:
parameters:
- name: metadata
in: query
required: false
style: deepObject
explode: true
schema:
type: object
additionalProperties:
type: string
full config is omitted to show just the part in question
Describe the bug you're encountering
I do not see any field for metadata in the UI
To reproduce...
- declare a query parameter of type
deepObject - open Swagger UI
Expected behavior
I should be seeing a field to enter metadata information
Screenshots
Additional context or thoughts
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No source file or test is named. Start by loading the provided OpenAPI 3.0.1 parameter definition in Swagger UI and inspect how query parameters with style deepObject and explode true are rendered; compare the behavior with issue #4216. Done means the UI exposes a metadata input for this definition without regressing other query parameters.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, openapi
- Domain
- api, frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100