(feature, typescript): Use generator-cli to generate reference.md #4062
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.
Feature
This updates the TypeScript generator to always generate the
reference.md
(this was previously feature flagged). An example of the generated markdown is shown below:Improvements
Additionally, the generator now uses the
generator-cli
to generate thereference.md
file, and this change fixes a bug where we were generating multiple sections for a single endpoint (one section for each example). We now only generate a single section per endpoint, preferring the first configured example over the rest.This also refactors the
generator-cli
client abstraction so that it simply acts as a way to call the CLI methods - a newReadmeGenerator
abstraction is introduced to encapsulate all of the logic required to create theReadmeConfiguration
(which acts just like theReferenceGenerator
).