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 deprecation check feature #40

Merged
merged 8 commits into from
Jun 9, 2019
Merged

Add deprecation check feature #40

merged 8 commits into from
Jun 9, 2019

Conversation

uuf6429
Copy link
Contributor

@uuf6429 uuf6429 commented Jun 8, 2019

This pull request adds support for ensuring deprecation in specs match with classes/methods marked as deprecated.

✔️ Included in PR

  • matrix in features.md was updated
  • every change is covered by tests
    • except CommandLineReporter since there are no tests for it
  • JAX-RS: checks for @Deprecated on method or class
  • Micronaut: checks for @Deprecated on method or class
  • OpenApi: checks for deprecated: true|false on operation
  • RAML: checks for deprecated annotation on resource(endpoint) or http method
  • Spring: checks for @Deprecated on method or class

⚠️ Notes

  • WADL is not supported (AFAIK it does not support deprecating)
  • didn't know which version to use in features.md

@uuf6429 uuf6429 changed the title Added deprecation feature Add deprecation check feature Jun 8, 2019
@cc-jhr
Copy link
Collaborator

cc-jhr commented Jun 8, 2019

Nice feature. Thank you for contributing this!

I am also not aware of a possibility to mark an endpoint as deprecated in WADL.

As for the version. I'd love to put it in the next release. Since this a new feature I'll change the next version to 2.3.0. You can change that in the feature matrix.

@cc-jhr cc-jhr added this to the v2.3.0 milestone Jun 8, 2019
Copy link
Collaborator

@cc-jhr cc-jhr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check the inline comments.

@cc-jhr cc-jhr added Hikaku Relates to core components JAX-RS Relates to the JaxRsConverter Micronaut Relates to the MicronautConverter OpenAPI Relates to the OpenApiConverter RAML Relates to the RamlConverter Spring Relates to the SpringConverter labels Jun 8, 2019
@cc-jhr cc-jhr self-requested a review June 9, 2019 10:21
@cc-jhr cc-jhr merged commit c02b7e0 into codecentric:master Jun 9, 2019
@uuf6429 uuf6429 deleted the Added-deprecation-feature branch June 9, 2019 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hikaku Relates to core components JAX-RS Relates to the JaxRsConverter Micronaut Relates to the MicronautConverter OpenAPI Relates to the OpenApiConverter RAML Relates to the RamlConverter Spring Relates to the SpringConverter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants