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

docs: add swagger spec #6

Open
wants to merge 2 commits into
base: next
Choose a base branch
from
Open

docs: add swagger spec #6

wants to merge 2 commits into from

Conversation

namhoang1604
Copy link
Contributor

@namhoang1604 namhoang1604 commented Nov 12, 2024

Description

This PR adds Swagger API spec

What type of PR is this? (check all applicable)

  • πŸ• Feature
  • πŸ› Bug Fix
  • πŸ“ Documentation Update
  • 🎨 Style
  • πŸ§‘β€πŸ’» Code Refactor
  • πŸ”₯ Performance Improvements
  • βœ… Test
  • πŸ€– Build
  • πŸ” CI
  • πŸ“¦ Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

https://github.com/gs-gs/fa-ag-trace/issues/681

Mobile & Desktop Screenshots/Recordings

image image

Added tests?

  • πŸ‘ yes
  • πŸ™… no, because they aren't needed
  • πŸ™‹ no, because I need help

Added to documentation?

  • πŸ“œ README.md
  • πŸ“• storybook
  • πŸ™… no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

Signed-off-by: Nam Hoang <[email protected]>
Copy link

github-actions bot commented Nov 12, 2024

Coverage report

St.❔
Category Percentage Covered / Total
🟒 Statements 94.05% 158/168
🟒 Branches 100% 29/29
🟒 Functions 82.61% 19/23
🟒 Lines 93.9% 154/164

Test suite run success

37 tests passing in 9 suites.

Report generated by πŸ§ͺjest coverage report action from 217cf34

@namhoang1604 namhoang1604 marked this pull request as ready for review November 12, 2024 08:59
Copy link
Collaborator

@ashleythedeveloper ashleythedeveloper left a comment

Choose a reason for hiding this comment

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

Hi @namhoang1604, if I change the accepted payloads in the request/response of the API, how is this change reflected in the API spec generated? Are we relying on the contributor to know to change the version of the API spec?

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 participants