Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate @service({version} #2821

Closed
timotheeguerin opened this issue Jan 24, 2024 · 1 comment · Fixed by #2902
Closed

Deprecate @service({version} #2821

timotheeguerin opened this issue Jan 24, 2024 · 1 comment · Fixed by #2902
Assignees
Labels
breaking-change A change that might cause specs or code to break deprecation A previously supported feature will now report a warning and eventually be removed triaged:core
Milestone

Comments

@timotheeguerin
Copy link
Member

from design #2812

  1. Deprecate @service({version}, cleanup docs to remove reference
  2. Add correct types and test for @OpenAPI.info to allow title and version (Somehow works already
  3. Add warning typespec-autorest or azure-core linter when using @OpenAPI.info({version}) (or general don't use openapi library)
@timotheeguerin timotheeguerin added breaking-change A change that might cause specs or code to break deprecation A previously supported feature will now report a warning and eventually be removed labels Jan 24, 2024
@markcowl markcowl added this to the [2024] March milestone Jan 26, 2024
@markcowl
Copy link
Contributor

est: 5

@timotheeguerin timotheeguerin self-assigned this Feb 9, 2024
timotheeguerin added a commit that referenced this issue Feb 28, 2024
…operties allowed by openapi (#2902)

fix [#2821](#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
markcowl pushed a commit to markcowl/cadl that referenced this issue 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
Labels
breaking-change A change that might cause specs or code to break deprecation A previously supported feature will now report a warning and eventually be removed triaged:core
Projects
None yet
2 participants