Update docs on trimming unused schemas #213
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…on .refitter file format The documentation is updated to include two new options, 'trimUnusedSchema' and 'keepSchemaPatterns', which are used for OpenAPI spec schema pruning. These changes provide users greater control over the generated code, especially when working with large schema definitions.
Extended the README.md documentation to include the new command-line options --trim-unused-schema and --keep-schema in order to provide instructions on how to minimize the generated output and selectively preserve certain schema. These options contribute to more efficient and customizable code generation.
…features Updated README files for Refitter.SourceGenerator, the main folder, and Refitter subfolder. Removed a redundant "namespace" field. Introduced two new optional fields, "trimUnusedSchema" and "keepSchemaPatterns", which enable more granular control over schema retention when generating code. The first removes unreferenced components schema to minimize the output, while the second uses regular expressions to specify which schema to keep even when "trimUnusedSchema" is true.
Extended the configuration in Program.cs by added more examples that demonstrate how to trim unused schemas and keep certain schemas. These examples are intended to improve user understanding of these features.
christianhelle
added
documentation
Codecov Report
@@ Coverage Diff @@
## main #213 +/- ##
=======================================
Coverage 98.30% 98.30%
=======================================
Files 55 55
Lines 2002 2002
=======================================
Hits 1968 1968
Misses 17 17
Partials 17 17
Flags with carried forward coverage won't be shown. Click here to find out more. |
|
Kudos, SonarCloud Quality Gate passed!
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The changes here align the README files and update the DocFX articles with basic information about trimming unused schemas, a feature that was introduced by @kirides in #199