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

[FEATURE] Mark deprecated properties with @Deprecated #418

Closed
2 tasks done
maltesmann opened this issue Oct 25, 2024 · 2 comments · Fixed by #421
Closed
2 tasks done

[FEATURE] Mark deprecated properties with @Deprecated #418

maltesmann opened this issue Oct 25, 2024 · 2 comments · Fixed by #421
Labels
enhancement New feature or request released

Comments

@maltesmann
Copy link
Contributor

maltesmann commented Oct 25, 2024

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?

  • I checked and didn't find a similar issue

🏢 Have you read the Contributing Guidelines?

Are you willing to work on this issue?

Yes I am willing to submit a PR!

@maltesmann maltesmann added the enhancement New feature or request label Oct 25, 2024
Copy link

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.

@asyncapi-bot
Copy link
Contributor

🎉 This issue has been resolved in version 1.6.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request released
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants