-
Notifications
You must be signed in to change notification settings - Fork 2
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
WIP: Reduce swagger docs boilerplate annotations #749
base: main
Are you sure you want to change the base?
Conversation
…nses for swagger.
…ents controller to reduce boiler plate code.
Kudos, SonarCloud Quality Gate passed!
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes look good, it's always great to see a reduction in duplicated boiler plate code!
Once merged in we need to ensure the wider development team/reviewers are aware of these annotations and use them for any new dev. We also need a strategy to apply this standard across the whole MAAT API project.
@Retention(RetentionPolicy.RUNTIME) | ||
@Target({ElementType.METHOD}) | ||
@ApiResponse( | ||
responseCode = "404", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The existing potential responses above show that HTTP 400 and 500 could be returned however this change makes the only expected response HTTP 404 (not previously an expected response). This seems to be changing our API documentation as well as removing boilerplate code?
What
Link to story
Describe what you did and why.
Checklist
Before you ask people to review this PR:
./gradlew test
git rebase main
.