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

[FEATURE]: Swagger Documentation #371

Merged
merged 58 commits into from
Aug 3, 2022
Merged

[FEATURE]: Swagger Documentation #371

merged 58 commits into from
Aug 3, 2022

Conversation

dsousa12
Copy link
Contributor

@dsousa12 dsousa12 commented Jul 25, 2022 •
edited
Loading

Relates to #296

Screenshots

image
image

Proposed Changes

  • Install Swagger packages;
  • Use decorators for type responses, parameteres and body on each endpoint;
  • Create default errors response classes to use on Swaggger.

This pull request closes #296

tutods and others added 30 commits July 19, 2022 14:20
@tutods
feat: add initial swagger configuration
76bdd2d
@tutods
feat: start swagger documentation on auth module
4816db1
@tutods
feat: update dependencies
73a0741
@tutods
fix: dependencies
85d1f3d
@tutods
feat: dependencies tests
3c8185a
@tutods
feat: start votes module documentation
89b6f31
@tutods
feat: create socket id dto to use on swagger docs
10c0ac5
@tutods
feat(swagger): add params and body decorators on votes
afa5a86
@tutods
feat(swagger): add decorators to user dtos
89d5eab
@tutods
feat(swagger): add decorators to team dtos
e5f5efa
@tutods
feat: add summary to team endpoints
9aecdce
@tutods
feat(swagger): add base errors responses
4a602c4
@tutods
feat(swagger): add tags on all controllers
ddf8440
@tutods
feat(swagger): add description on team dto
a98334b
@tutods
feat(swagger): update teams dtos
4804f8c
@tutods
feat(swagger): add dto and params decorators to comments module
e66bc1d
@geomarb
fix: change post auth/updatepassword route to patch auth/password
cc478bc
@geomarb
fix: change post auth/recoverPassword route to patch auth/password/reset
722fef9
@geomarb
fix: change get auth/dashboardStatistics route to get auth/statistics
3cdc751
@tutods
feat(swagger): add decorators to cards
b14cc34
@geomarb
feat: change routes and req method for check email endpoint
0203085
@geomarb
chore: move azure route to controller
f8efe2b
@dsousa12
fix(frontend-backend): dependencies
93a9666
@dsousa12
feat(swagger): type board dto
19adc4e
@dsousa12
feat(frontend): update azure and auth paths
414ebfa
@dsousa12
feat(swagger): add decorators do board dtos
59097f7
@dsousa12
feat(swagger): azure endpoints
c1a6b86
@dsousa12
feat(swagger): auth module response decorators
48d46c1
@dsousa12
feat(swagger): add response decorators and types to votes module
b6979cd
@geomarb
feat: change routes and req method for check email endpoint in fronte…
8e15d64 
…nd for azure
@dsousa12 dsousa12 requested review from nunocaseiro and a team July 25, 2022 15:28
@dsousa12 dsousa12 linked an issue Jul 25, 2022 that may be closed by this pull request
[FEATURE]: Swagger Documentation #296
Closed
26 tasks
@dsousa12 dsousa12 changed the title Feat swagger documentation [FEATURE]: Swagger Documentation Jul 25, 2022
nunocaseiro
nunocaseiro requested changes Aug 1, 2022
View reviewed changes
Copy link
Contributor

@nunocaseiro nunocaseiro left a comment

Choose a reason for hiding this comment

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

Amazing job! Before the merge please verify if this pr doesn't break any feature

backend/src/app.module.ts Outdated Show resolved Hide resolved
backend/src/modules/cards/controller/cards.controller.ts Outdated Show resolved Hide resolved
dsousa12 and others added 3 commits August 2, 2022 07:28
@dsousa12 @nunocaseiro
Update backend/src/modules/cards/controller/cards.controller.ts
4eb0a97 
Co-authored-by: Nuno Caseiro <90208434+nunocaseiro@users.noreply.github.com>
@dsousa12 @nunocaseiro
Update backend/src/app.module.ts
96e6dc5 
Co-authored-by: Nuno Caseiro <90208434+nunocaseiro@users.noreply.github.com>
@dsousa12
fix: pr conflicts
1c82781
geomarb
geomarb requested changes Aug 2, 2022
View reviewed changes
Copy link
Contributor

@geomarb geomarb left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Congratulations there is a huge and great work here, and the most important part: it works perfectly! There are some small adjustments to be done in the code.

backend/src/libs/swagger/errors/bard-request.swagger.ts Outdated Show resolved Hide resolved
backend/src/libs/swagger/errors/bard-request.swagger.ts Outdated Show resolved Hide resolved
backend/src/libs/swagger/errors/forbidden.swagger.ts Outdated Show resolved Hide resolved
backend/src/libs/swagger/errors/not-found.swagger.ts Outdated Show resolved Hide resolved
frontend/src/api/boardService.tsx Outdated Show resolved Hide resolved
@dsousa12 dsousa12 requested review from geomarb, nunocaseiro and a team August 2, 2022 13:08
geomarb
geomarb approved these changes Aug 2, 2022
View reviewed changes
Copy link
Contributor

@geomarb geomarb left a comment

Choose a reason for hiding this comment

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

Perfect!!!

@dsousa12 dsousa12 requested review from nunocaseiro and removed request for nunocaseiro August 3, 2022 06:12
nunocaseiro
nunocaseiro approved these changes Aug 3, 2022
View reviewed changes
Copy link
Contributor

@nunocaseiro nunocaseiro left a comment

Choose a reason for hiding this comment

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

Great job!

@dsousa12 dsousa12 merged commit 309b78b into main Aug 3, 2022
@dsousa12 dsousa12 deleted the feat-swagger-documentation branch August 3, 2022 14:22
dsousa12 added a commit that referenced this pull request Aug 4, 2022
@dsousa12 @tutods
@geomarb @joaosantos99 @CatiaBarroco-xgeeks @f-morgado @nunocaseiro @dvpfran
[FEATURE]: Swagger Documentation (#371)
af86e3e 
Co-authored-by: Daniel Sousa @tutods <jdaniel.asousa@gmail.com>
Co-authored-by: Geomar Bastiani <g.bastiani@kigroup.de>
Co-authored-by: João Santos <68588265+joaosantos99@users.noreply.github.com>
Co-authored-by: joaosantos99 <jfss291@gmail.com>
Co-authored-by: Catia Barroco <104831678+CatiaBarroco-xgeeks@users.noreply.github.com>
Co-authored-by: Francisco Morgado <f.morgado@kigroup.de>
Co-authored-by: Daniel Sousa <tutods@Macbook-Pro.local>
Co-authored-by: Nuno Caseiro <90208434+nunocaseiro@users.noreply.github.com>
Co-authored-by: CatiaBarroco-xgeeks <104831678+CatiaBarroco-xgeeks@users.noreply.github.com>
Co-authored-by: Luís Francisco <67462841+dvpfran@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nunocaseiro nunocaseiro nunocaseiro approved these changes

@geomarb geomarb geomarb approved these changes

Assignees

@geomarb geomarb

@dsousa12 dsousa12

Labels
backend documentation Improvements or additions to documentation enhancement New feature or request
Projects
SPLIT • Backend
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[FEATURE]: Swagger Documentation
6 participants
@dsousa12 @geomarb @nunocaseiro @tutods @CatiaBarroco-xgeeks @dvpfran