Deprecate @service version and allow @OpenAPI.info to take all properties allowed by openapi
#2902
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
timotheeguerin
requested review from
bterlson,
daviwil,
markcowl and
allenjzhang
as code owners
timotheeguerin
changed the title
@service version and allow @OpenAPI.info to take all properties allowed by openapi
|
All changed packages have been documented. |
|
You can try these changes at https://cadlplayground.z22.web.core.windows.net/prs/2902/ Check the website changes at https://tspwebsitepr.z22.web.core.windows.net/prs/2902/ |
timotheeguerin
added
the
deprecation
bterlson
approved these changes
Feb 9, 2024
markcowl
pushed a commit
to markcowl/cadl
that referenced
this pull request
Mar 8, 2024
…operties allowed by openapi (microsoft#2902) fix [microsoft#2821](microsoft#2821) ## Deprecate `@service({version` Using this property will emit a deprecation warning ## Cover everything with `@OpenAPI.info` Makes sure all the properties allowed on the `info` object of openapi specification can also be provided in `@info`. The properties will either override other ways of specifying those previously or be the only way. - `@info({description` would override `@doc` on service namespace - `@info({summary` would override `@summary` on service namespace - `@info({title` would override `@service({title}` on service namespace
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.
fix #2821
Deprecate
@service({versionUsing this property will emit a deprecation warning
Cover everything with
@OpenAPI.infoMakes sure all the properties allowed on the
infoobject of openapi specification can also be provided in@info. The properties will either override other ways of specifying those previously or be the only way.@info({descriptionwould override@docon service namespace@info({summarywould override@summaryon service namespace@info({titlewould override@service({title}on service namespace