Fix mustache template: Only add the deprecation message to the Obsolete-tag if it exists #1068
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
gcatanese
requested changes
Oct 8, 2024
There was a problem hiding this comment.
Changes are fine.
Keep into consideration that for the endpoints there is the x-deprecatedInVersion extension without vendorExtensions.x-deprecatedMessage, in this case the formatting could look wrong.
Suggestions:
- check also if
x-deprecatedMessageis available - format the message differently, instead of using
-use a.
…dMessage is empty
|
gcatanese
approved these changes
Oct 9, 2024
ayodejidev
approved these changes
Oct 10, 2024
Merged
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.
Description
This PR addresses the
[Obsolete]-tag in the model and service mustache templates. These should only be shown if the message is available in the specs.Tested scenarios
Example with
CardDetails.cupsecureplusSmscodeBefore:
After:
I kept the template easy-to-read, I didn't want to make an exception for the empty case, e.g. just
[Obsolete]without the double quotes and brackets("")Example with just the deprecation version:
Example with the deprecation message and version: