Add script to fix title/descriptions for service Swaggers #35182
+148
−0
Conversation
This file contains hidden or 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
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
|
PR validation pipeline started successfully. If there is ApiView generated, it will be updated in this comment. |
mikeharder
requested changes
Jun 10, 2025
There was a problem hiding this comment.
@matthchr: Can you provide more context on this change? We typically don't commit scripts like this, especially not written in Python (this repo uses JS).
|
Let me add you to the internal mail thread. |
|
Added you to the internal mail thread. Also updated the PR description to be clearer. |
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.
While many tools consuming the Swagger specifications used to honor title + description for fields in the
definitionssection, they no longer do. When discussing this with the SDK teams, the consensus was that we should move away from title/description to just putting everything in description, as this is what typespec is eventually going to do as well.This script automates the title + description -> description migration.