PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs
Huge swagger.json file is not being processed
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 315
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 7
Description
I have a swagger.json file with almost 150 000 lines for my API.
I want to generate the documentation (mdx files) with this plugin, but it doesn't run.
yarn docusaurus gen-api-docs myapi
Simply doesn't generate anything and kinda hangs.
Is it because the file is too big?
How do you get around such a problem?
Thanks
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 reproducing yarn docusaurus gen-api-docs myapi with the reported nearly 150,000-line swagger.json file. Trace whether generation hangs because of the specification size and establish the expected behavior for generating the MDX documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100