PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs
Support for deepObjects in query parameters
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 315
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 7
Description
Documentation link
N/A
Describe the problem
Request for improvement.
We are looking for support for the deepObject notation. Given the following example specification:
name: query
in: query
description: |
Allows for pagination and sorting.
required: false
schema:
type: object
properties:
limit:
type: integer
description: The limit of results to return
example: 100
offset:
type: integer
description: The number of records to offset
example: 50
order:
type: string
description: The attribute to order by
example: created_at
style: deepObject
explode: true
Today the plugin loads in the query parameter, but does not describe anything about the properties of the schema (limit, offset, order).
Suggested fix
We would like to see described in the UI the ability to use the deepObject notation as follows:
/users?query[limit]=100&query[offset]=2
We would also like to see the description and example for each property under the query parameter query
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 by tracing how the plugin renders query parameters in its generated API reference UI and how object schemas are currently represented. Use the provided deepObject specification as the reproduction case, and verify that the rendered documentation exposes each property’s description, example, and query notation.
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