workarounds - normalize example value in resource ID user specified segment to prevent erroneous diffs
#4465
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
…ent erroneous diffs
jackofallops
approved these changes
Oct 4, 2024
zaowang-ms
pushed a commit
to zaowang-ms/pandora
that referenced
this pull request
Oct 22, 2024
…ent erroneous diffs (hashicorp#4465)
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.
At some point we began experiencing flapping diffs in the example value for resource ID segments
Example PR of this phenomenon:
#4433
#4461
This workaround was added to standardize the resource ID segments to be consistent when resource IDs that are actually the same are defined with different user defined segments in the swagger e.g.
/subscription/{subscriptionId}/resourceGroup/resourceGroupName/provider/Microsoft.SomeProvider/virtualMachines/{virtualMachineName}/subscription/{subscriptionId}/resourceGroup/resourceGroupName/provider/Microsoft.SomeProvider/virtualMachines/{name}The example value which is metadata that we populate for documentation purposes when generating resources actually uses the same value that the segment name does, so this workaround should apply to the example value as well.
When merged this should cause a one time change of
3298 files changed, 4570 insertions(+), 4570 deletions(-)(Not taking into account any config changes that were merged as well)