Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(feature, typescript): Use generator-cli to generate reference.md #4062

Merged
merged 6 commits into from
Jul 15, 2024

Conversation

amckinney
Copy link
Member

@amckinney amckinney commented Jul 15, 2024

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:

image

Improvements

Additionally, the generator now uses the generator-cli to generate the reference.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 new ReadmeGenerator abstraction is introduced to encapsulate all of the logic required to create the ReadmeConfiguration (which acts just like the ReferenceGenerator).

@amckinney amckinney requested a review from dsinghvi as a code owner July 15, 2024 20:45
@amckinney amckinney changed the title (improvement, typescript): Use generator-cli to generate reference.md (feature, typescript): Use generator-cli to generate reference.md Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants