feat: adding generation script #563
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a generation script for creating assets within docs based on API specs. The aim is to run this script on a regular basis (or perhaps on changes), and automatically regenerate .mdx files, .json specs, and alter the docs.json navigation file on every run.
Spec Generation
/main, and after processing, the generated files will be in/main/oasMDX File Generation
openapiheader containing the .json spec file, method, and path for the endpoint.Docs.json Alteration
References
DM-72
Testing
Testing can be performed by making sure the correct .json specs are in
/main, and their names and other information matches what is specified in the config at the top of the script.From the
mainfolder:node scripts/artifact-generationChecklist