asyncapi / java-spring-template

Java Spring template for the AsyncAPI Generator
Apache License 2.0
66 stars 54 forks source link

[FEATURE] Mark deprecated properties with @Deprecated #418

Open maltesmann opened 1 week ago

maltesmann commented 1 week ago

Why do we need this improvement?

Changes in the event-model between software components implemented by different teams sometimes require to be non-breaking. Therefore to be removed properties are not removed directly but marked with deprecated: true in the specification.

How will this change help?

For the developer only working with the generated code it would be much easier to directly see the deprecation in the IDE instead of having to look out for deprecations in the specification.

Screenshots

No response

How could it be implemented/designed?

Add the @Deprecated annotation to getters and setters in generated model classes where deprecated: true

🚧 Breaking changes

No

👀 Have you checked for similar open issues?

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue?

Yes I am willing to submit a PR!

github-actions[bot] commented 1 week ago

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.