PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs
[FR] Use query param examples in demo/code example
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?
Not sure if this is a bug or a feature request. I would like to show examples of query parameters in the code sample snippets, but adding them as examples to my parameters does not cause them to be included either there or in the demo sidebar.
Describe the solution you'd like
Adding an example to a query param should make it be included in the demo box and the code snippets, similar to the way that examples are added to request bodies.
Describe alternatives you've considered
N/A
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
Locate the query-parameter handling used by the demo sidebar and generated code snippets, then compare it with the existing request-body example handling. Done means an example on a query parameter appears in both the demo box and the code samples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, react, typescript
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100