OpenAPITools / OpenAPITools/openapi-generator
[typescript-axios] doesn't serialize deepObject query params
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue?
- Have you validated the input using an OpenAPI validator (example)?
- Have you tested with the latest master to confirm the issue still exists?
- Have you searched for related issues/PRs?
- What's the actual output vs expected output?
input:{day: 20, year: {min: 1990, max: 2000}}
actual output:?day=20&year
expected output:?day=20&year[min]=1990&year[max]=2000
Description
I'm using [typescript-axios] api client generator. Some of the properties I pass to it specified as deepObject. It looks that it doesn't support this type of args at all. Is there any possible ways to fix it?
openapi-generator version
v4.3.1
v5.0.0-beta
OpenAPI declaration file content or url
YearRange:
in: query
name: year
required: false
style: deepObject
schema:
type: object
properties:
min:
type: string
example: 2010
max:
type: string
example: 2019
Generation Details
[typescript-axios] generator
Steps to reproduce
Related issues/PRs
https://github.com/OpenAPITools/openapi-generator/pull/6075
Suggest a fix
Replace old deprecated url API with URLSearchParams.
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
Start with the typescript-axios generator entry point and reproduce the issue using the OpenAPI declaration and input shown here. Trace query serialization for the deepObject parameter, then verify that the generated client produces the expected bracketed year[min] and year[max] query parameters.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100