swagger-api / swagger-api/swagger-ui

Additional/custom parameters from user?

Open
#5,579 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cat: try-it-out specification: 3.x type: enhancement
Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Is there a way to spec custom parameters? We have some set parameters for multipart/form-data, but we also allow any number of additional string: string combinations. Is there anyway to incorporate that on the UI and/or spec? Like when you add additional rows in postman?

For context, the additional custom inputs are additional metadata for the document.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing Swagger UI's multipart/form-data handling and the OpenAPI request schema for additional string-to-string metadata. Clarify whether the desired change belongs in the specification, the UI, or both, and define done as supporting user-added metadata rows while preserving the existing fixed parameters.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, openapi
Domain
api, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.