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.

Sign up for GitHub

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

Jump to bottom

FEAT: Swagger API documentation #34

Closed
5 tasks done
JKaypa opened this issue Aug 20, 2024 · 5 comments · Fixed by #17
Closed
5 tasks done

FEAT: Swagger API documentation #34

JKaypa opened this issue Aug 20, 2024 · 5 comments · Fixed by #17
Assignees
@DaniellaZambrano @JKaypa
Labels
BE Backend feature QA QA tasks
Milestone
Pre-DEMO Release

Comments

@JKaypa
Copy link
Collaborator

JKaypa commented Aug 20, 2024 •
edited by DaniellaZambrano
Loading

What feature?

  • Update swagger
  • Add sign-in swagger docs

Acceptance criteria

Following this doc: https://docs.google.com/document/d/1WCvmZwpYSouGX9Jji0Eu6JmsGEtEpxSeF12wAJmQxZs/edit?usp=sharing

  • Use the updated Swagger documentation to test all described endpoints.
  • Ensure that the documented behavior matches the actual API responses and functionality.
  • Address any discrepancies found during testing and update the documentation accordingly.
@JKaypa JKaypa converted this from a draft issue Aug 20, 2024
@JKaypa JKaypa self-assigned this Aug 20, 2024
@JKaypa JKaypa added the BE Backend feature label Aug 20, 2024
@JKaypa JKaypa added this to the Release 1.0 milestone Aug 20, 2024
@JKaypa JKaypa linked a pull request Aug 20, 2024 that will close this issue
OV-2: FEAT: Sign-in flow #17
Merged
@JKaypa JKaypa changed the title Feat: Swagger API documentation FEAT: Swagger API documentation Aug 20, 2024
@github-project-automation github-project-automation bot moved this from Peer Review to Testing in bsa-2024-outreachvids Aug 21, 2024
@DaniellaZambrano DaniellaZambrano added the QA QA tasks label Aug 21, 2024
@DaniellaZambrano DaniellaZambrano self-assigned this Aug 21, 2024
@DaniellaZambrano
Copy link
Collaborator

Successful testing of a part of the FE functionality is complete, but full testing is blocked until the FEAT: Sign Up flow (BE) part is implemented

Attach FE Image

@DaniellaZambrano
Copy link
Collaborator

Waiting for FEAT: Sign Up flow (BE) because what we currently have will change according to the requirements and what has already been completed for FEAT: Sign Up flow (FE)

Image

@DaniellaZambrano DaniellaZambrano moved this from To Be Tested to In Testing in bsa-2024-outreachvids Aug 26, 2024
@DaniellaZambrano
Copy link
Collaborator

To test use last version on github of the branch "next" and follow the link
http://localhost:3001/v1/documentation/

@DaniellaZambrano
Copy link
Collaborator

DaniellaZambrano commented Aug 26, 2024 •
edited
Loading

@JKaypa The schema of sign-up changes, so I'll move this ticket to In Progress column for you to solve it.

According to the daily, it's @JPjok3r 's task to finish implementing the Swagger, right?

@DaniellaZambrano DaniellaZambrano assigned JPjok3r and unassigned JPjok3r Aug 27, 2024
@DaniellaZambrano
Copy link
Collaborator

Testing is done with the API implementation for now, and we've agreed that each new endpoint will be implemented swagger doc by the developer assigned to it.

@DaniellaZambrano DaniellaZambrano moved this from In Progress to Done in bsa-2024-outreachvids Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DaniellaZambrano DaniellaZambrano

@JKaypa JKaypa

Labels
BE Backend feature QA QA tasks
Projects
bsa-2024-outreachvids
Status: Done
Milestone
Pre-DEMO Release
Development

Successfully merging a pull request may close this issue.

OV-2: FEAT: Sign-in flow BinaryStudioAcademy/bsa-2024-outreachvids
3 participants
@DaniellaZambrano @JPjok3r @JKaypa