Skip to content
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

Create Api documentation #37

Merged
merged 12 commits into from
Dec 14, 2023
Merged

Create Api documentation #37

merged 12 commits into from
Dec 14, 2023

Conversation

Wineshuga
Copy link
Collaborator

@Wineshuga Wineshuga commented Dec 14, 2023

Description

The following additions/modifications were made on this branch:

  • API documentation was made using rswag gem and swagger ui
  • The README file was modified to implement suggested changes from the code reviewer
  • The test folder and its contents were deleted as the spec folder is used for testing instead

@Wineshuga Wineshuga linked an issue Dec 14, 2023 that may be closed by this pull request
Copy link
Owner

@tan12082001 tan12082001 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can merge the branch🎊🟢

README.md Outdated
Comment on lines 111 to 112
Reference the API documentation for details on how to interact with the API.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add the instruction for /api-docs route for the API documentation until we deploy the page.

@Wineshuga Wineshuga merged commit 2b5a6a0 into dev Dec 14, 2023
2 checks passed
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.

[3.5pt] - API Documentation
3 participants