PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs
Incorrect rendering when referencing data from schema
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 315
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 7
Description
Problem with Generating Swagger Files
There is an issue when generating Swagger files that use schemas referenced by other YAML files. This problem leads to compilation errors during project build due to the generation of empty tags in .mdx files, which cannot be rendered.
Example of Issue
common-schema.yaml
operative.yaml
Example of the generated .mdx file, with some of the mentioned empty tags.
Displayed error when compiling server.
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
Reproduce the generation using the referenced common-schema.yaml and operative.yaml inputs, then inspect the generated .mdx file for the empty tags shown in the report. Trace how schemas referenced from another YAML file are converted into documentation and run the project build to confirm the compilation error. Done means referenced schemas generate valid MDX without empty tags and the server build completes successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript, yaml
- Domain
- build-system, documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100