Skip to content

docs(api): add Swagger @ApiResponses for OAuthClientController#3759

Open
Shivamrut wants to merge 2 commits intoeclipse-sw360:mainfrom
Shivamrut:2565
Open

docs(api): add Swagger @ApiResponses for OAuthClientController#3759
Shivamrut wants to merge 2 commits intoeclipse-sw360:mainfrom
Shivamrut:2565

Conversation

@Shivamrut
Copy link
Contributor

@Shivamrut Shivamrut commented Feb 25, 2026

Fixes: #2565

Summary

  • Added @Operation, @ApiResponses, @Tag, and @SecurityRequirement annotations to all 3 endpoints in OAuthClientController (GET, POST, DELETE)
  • Documented response codes: 200, 400, 401, 403, 500 based on actual return paths in the code
  • Added springdoc-openapi-starter-webmvc-ui dependency to the authorization-server module's pom.xml (same pattern as resource-server)

Files Changed

  • rest/authorization-server/pom.xml — added springdoc-openapi dependency
  • rest/authorization-server/src/.../OAuthClientController.java — added Swagger annotations

Test Plan

  • mvn clean install -pl rest/authorization-server -am -DskipTests — BUILD SUCCESS
  • mvn test -pl rest/authorization-server — 12 tests run, 0 failures, 0 errors

Issue: #2565

Signed-off-by: Shivamrut <gshivamrut@gmail.com>
@Shivamrut
Copy link
Contributor Author

@GMishx @amritkv @KoukiHama Please review this PR, I have tested the build and unit test case, everything pass. Any changes please let me know

@GMishx GMishx added needs code review needs general test This is general testing, meaning that there is no org specific issue to check for labels Mar 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs code review needs general test This is general testing, meaning that there is no org specific issue to check for

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Swagger update required

2 participants