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

Add support for deprecated fields #2830

Open
detomarco opened this issue Dec 20, 2024 · 0 comments
Open

Add support for deprecated fields #2830

detomarco opened this issue Dec 20, 2024 · 0 comments

Comments

@detomarco
Copy link

Is your feature request related to a problem? Please describe.
I deprecated a field in Kotlin, I'd like to have the deprecated annotation in the schema

  • A clear and concise description of what the problem is. Ex. I'm always frustrated
    when [...]

I defined this data class in Kotlin

data class Car(
     @Deprecated
     val model: String
)
  • What is the actual result using OpenAPI Description (yml or json)?
components:
  schemas:
    Car:
      required:
      - brand
      type: object
      properties:
        brand:
          type: string

Describe the solution you'd like

components:
  schemas:
    Car:
      required:
      - brand
      type: object
      properties:
        brand:
          deprecated: true
          type: string
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant