PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs
Example & externalDocs attributes not displaying
Open
Nobody has claimed this yet.
enhancement
roadmap
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 315
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 7
Description
Example & externalDocs attributes not displaying
In our api spec we add example values for our properties and externalDocs. These are not displayed in the output
properties:
label:
maxLength: 50
minLength: 0
type: string
description: Label of the license plan
rateLimitTokens:
type: integer
description: Amount of API requests the customer can do in one hour
format: int32
example: 1000
externalDocs:
description: Rate limiting
url: https://exampleUrl.com
Describe the solution you'd like
Possible solution:
Describe alternatives you've considered
We used Swizzling to add our own SchemaItem component
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 locating the SchemaItem component used for the generated API reference output and compare it with the OpenAPI example and externalDocs fields described here. Confirm how the existing swizzling workaround handles them, then verify that both attributes are displayed in the rendered documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, react, typescript
- Domain
- documentation, frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100