Support @summary on data types in OpenAPI3, emitting title
#2597
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
bterlson
requested review from
daviwil,
markcowl,
allenjzhang and
timotheeguerin
as code owners
|
Changes in this PR will be published to the following url to try(check status of TypeSpec Pull Request Try It pipeline for publish status): Website: https://tspwebsitepr.z22.web.core.windows.net/prs/2597/ |
timotheeguerin
approved these changes
Oct 20, 2023
|
@mikekistler approves this approach so we can merge. |
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.
This PR allows @summary on models, enums, etc., and emits the JSON Schema
titlefield. This is perhaps a bit strange, given that in OpenAPI summary and title are different, however in JSON Schema, we use@summaryto emit title already, so this just aligns the two. Additionally, the description ofsummaryin OpenAPI andtitlein JSON Schema are effectively identical.