Skip to content

feat: add Swagger API documentation to community service - #1211

Open
Mrsandeep27 wants to merge 9416 commits into
Vacademy-io:mainfrom
Mrsandeep27:feature/swagger-docs-community-service
Open

feat: add Swagger API documentation to community service#1211
Mrsandeep27 wants to merge 9416 commits into
Vacademy-io:mainfrom
Mrsandeep27:feature/swagger-docs-community-service

Conversation

@Mrsandeep27

Copy link
Copy Markdown

Summary

Closes #1197

  • Added @Tag, @Operation, @ApiResponse, and @Parameter OpenAPI annotations to:
    • ChapterController - chapter/topic management endpoints
    • AdminSessionController - all 10 live session management endpoints
  • Documentation includes summaries, descriptions, response codes, and parameter details
  • Swagger UI already accessible at /community-service/swagger-ui.html (springdoc configured)

Test plan

  • Access /community-service/swagger-ui.html and verify documentation renders
  • Confirm all annotated endpoints appear with descriptions
  • Test API docs at /community-service/api-docs returns valid OpenAPI JSON

Generated with Claude Code

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Swagger API documentation to community service

9 participants