api: Prefer built-in type "url" over "string" for URL fields #951
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
added 2 commits
December 9, 2024 13:27
No API changes, just re-running "make generate". You may notice some of the indentation and other stylistic changes in the generated code are non-sensical but that's just the tool.
This is just an API clarification. It does not change the generated Golang code, but merely adds a "format: uri" attribute to the string fields in openapi.json.
This was referenced Dec 10, 2024
bennerv
approved these changes
Dec 10, 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.
What this PR does
While working on #950 I realized TypeSpec has a built-in type for URL strings, which seemed appropriate to use for certain string fields in the API.
This does not change the generated Go code at all. All it does is add a "format: uri" qualifier to these string fields in
openapi.json, which I don't even know if ARM cares about but why not.Jira: None, just tweaking.
Link to demo recording:
Special notes for your reviewer