docs(api): add Swagger @ApiResponses for OAuthClientController#3759
docs(api): add Swagger @ApiResponses for OAuthClientController#3759Shivamrut wants to merge 5 commits intoeclipse-sw360:mainfrom
Conversation
Signed-off-by: Shivamrut <gshivamrut@gmail.com>
|
@GMishx @amritkv @KoukiHama Please review this PR, I have tested the build and unit test case, everything pass. Any changes please let me know |
|
The documentation for Not sure this PR in current state would be helpful in any manner. |
|
Thanks for the feedback, @GMishx. Could you please confirm the expected direction so I can update this correctly?
Also, one clarification from my side: do we want auth-server Swagger to be publicly useful for users/integrators (e.g., OAuth client-management endpoints), or is documenting only resource-server APIs the intended scope? If option 1, I’ll update this PR to make auth-server Swagger endpoints accessible and share the exact URL here. |
Works on: #2565
Summary
@Operation,@ApiResponses,@Tag, and@SecurityRequirementannotations to all 3 endpoints inOAuthClientController(GET, POST, DELETE)springdoc-openapi-starter-webmvc-uidependency to theauthorization-servermodule'spom.xml(same pattern asresource-server)Files Changed
rest/authorization-server/pom.xml— added springdoc-openapi dependencyrest/authorization-server/src/.../OAuthClientController.java— added Swagger annotationsTest Plan
mvn clean install -pl rest/authorization-server -am -DskipTests— BUILD SUCCESSmvn test -pl rest/authorization-server— 12 tests run, 0 failures, 0 errorsIssue: #2565