swagger-api / swagger-api/swagger-ui
Display parameter style/explode
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
As an API consumer,
I want to know how operation parameters should be serialized.
OpenAPI 3.0 supports various combinations of style+explode to serialize parameters. However, Swagger UI does not display this information anywhere, so the users don't know how parameters are formatted unless they use "try it out". As a user I need to know, for example, whether a multi-value query parameter should be formatted at ?ids=1,2,3 or ?ids=1|2 or ?ids=1&ids=2 or in some other way.
Content & configuration
Swagger/OpenAPI definition:
openapi: 3.0.0
info:
title: Multi-value array parameter
version: 0.0.1
paths:
/foo:
get:
parameters:
- name: status
in: query
schema:
type: array
items:
type: string
enum:
- available
- pending
- sold
# ?status=available|sold
style: pipeDelimited
explode: false
responses:
200:
description: ok

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
Begin by tracing how Swagger UI renders OpenAPI 3.0 operation parameters, using the sample definition and style/explode combinations in this issue. The work is done when the parameter display tells users how values are serialized, including the shown pipe-delimited example and other supported combinations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100