Skip to content

chore: update swagger documentation#697

Merged
phoenixdahdev merged 2 commits intohngprojects:devfrom
lurldgbodex:chore/swagger-doc
Mar 2, 2025
Merged

chore: update swagger documentation#697
phoenixdahdev merged 2 commits intohngprojects:devfrom
lurldgbodex:chore/swagger-doc

Conversation

@lurldgbodex
Copy link
Contributor

@lurldgbodex lurldgbodex commented Mar 1, 2025

Description
update the swagger documentation to be more comprehensive to allow users fully understand and easier to integrate in accordance with issue #686.

what was done

  • clear description of the controller
  • clear request and response format
  • clear media type

Acceptance criteria

  • Controllers has meaningful descriptions
  • Each endpoints has meaning description
  • Response and Request format is specified
  • Response and Request type is specified

closes #686

@phoenixdahdev phoenixdahdev merged commit 775e869 into hngprojects:dev Mar 2, 2025
1 check failed
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.

[CHORE]: Improve Swagger Documentation

2 participants