PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs
Support objects in query params
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 315
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 7
Description
Is your feature request related to a problem?
I'm wondering if you support objects as query params. I've been trying to use this feature, which seems to be supported by OAS 3.0, but it seems you treat objects as strings.
This is how I define an object inside a query param.

This is how it appears in the query params list.

And this is how it appears in the Send API Request side.

Am I doing something wrong? Or misunderstanding something perhaps?
Describe the solution you'd like
I'd like to know if this feature is in already considered, or will never be.
Describe alternatives you've considered
One alternative I see is using the Swagger 2.0 approach, as described here.
Additional context
I know a lot of APIs use objects inside query params, and it would be nice if this feature was implemented. Also, I know the response body does interpret objects properly, so that's probably just a bug or missing code?
Thank you very much in advance!
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 OpenAPI 3.0 query-parameter definition and the Send API Request flow described in the issue. Compare the current object handling with the Swagger 2.0 alternative; done means object-valued query parameters are represented and sent as intended, with the behavior confirmed in the generated API reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100