feat(config): add transient field serialization options #112
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
Introduce separate config options for serializing transient fields in request and response objects, replacing the deprecated `skipTransientField` option. This allows for explicit control over the inclusion of `transient` fields in the generated documentation. BREAKING CHANGE: `skipTransientField` has been removed in favor of `serializeRequestTransients` and `serializeResponseTransients`. To maintain the previous behavior, set both new options to `false`.
shalousun
approved these changes
Sep 1, 2024
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.
Introduce separate config options for serializing transient fields in request and response objects, replacing the deprecated
skipTransientFieldoption. This allows for explicit control over the inclusion oftransientfields in the generated documentation.BREAKING CHANGE:
skipTransientFieldhas been removed in favor ofserializeRequestTransientsandserializeResponseTransients. To maintain the previous behavior, set both new options tofalse.TongchengOpenSource/smart-doc#904