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

Autogenerating API Documentation #49

Merged
merged 10 commits into from
Mar 15, 2023
Merged

Autogenerating API Documentation #49

merged 10 commits into from
Mar 15, 2023

Conversation

G0maa
Copy link
Owner

@G0maa G0maa commented Mar 6, 2023

  • Still refining the current solution.
  • Solves: Need actual API Docs #40
  • Out of all the topics I've "researched", this one had the most bizarre "solutions" & is one of the problems that made me wish I had used something like NestJS, Adonis? or any "batteries-included" framework.

@G0maa
Copy link
Owner Author

G0maa commented Mar 6, 2023

@G0maa
Copy link
Owner Author

G0maa commented Mar 6, 2023

Tests fail because of this, to be fixed sometime:

c5d81af#diff-841254fe75488c1bd4cd7f68f00b4be0e48dcfbc4a16b45847b68295e0e3b27bR92

@codecov
Copy link

codecov bot commented Mar 15, 2023

Codecov Report

Merging #49 (d06a3c0) into master (bb0439e) will increase coverage by 4.75%.
The diff coverage is 66.38%.

@@            Coverage Diff             @@
##           master      #49      +/-   ##
==========================================
+ Coverage   77.96%   82.72%   +4.75%     
==========================================
  Files          32       40       +8     
  Lines        2237     2940     +703     
  Branches      119      118       -1     
==========================================
+ Hits         1744     2432     +688     
- Misses        487      502      +15     
  Partials        6        6              
Impacted Files Coverage Δ
src/controllers/activeSubject.ts 69.15% <40.00%> (-6.71%) ⬇️
src/controllers/fee.ts 74.78% <40.00%> (-7.03%) ⬇️
src/controllers/grade.ts 71.84% <40.00%> (-7.68%) ⬇️
src/controllers/studyClass.ts 67.96% <40.00%> (-6.74%) ⬇️
src/controllers/subjectsMaterial.ts 72.88% <40.00%> (-6.72%) ⬇️
src/app.ts 91.00% <54.54%> (-4.70%) ⬇️
src/controllers/student.ts 84.31% <73.17%> (-4.08%) ⬇️
src/controllers/subject.ts 89.71% <80.00%> (-2.24%) ⬇️
src/controllers/auth.ts 99.17% <100.00%> (+0.27%) ⬆️
src/controllers/holiday.ts 100.00% <100.00%> (ø)
... and 2 more

... and 16 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@G0maa G0maa merged commit 69b68af into master Mar 15, 2023
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.

1 participant