PIMS-1884 Swagger Rework

[dbarkowsky]

🎯 Summary

PIMS-1884

Swagger Autogen was not doing a sufficient job of generating documentation. Moving to a manually-defined documentation structure.

Follows this structure:

• Write Swagger documentation in .swagger.yaml files
• Place these files alongside their relevant routes

Changes

• Remove swagger-autogen package and commands
• Add .yaml files that manually define routes

While writing documentation, these are the changes that happened as a result.

• Notifications service now updates the updated by field when the CHES status is updated.
• Removed unused routes from /tools, /roles, and /users
  • In some cases, the controllers were removed as well.
• Changed orWhere condition in some queries to andWhere. This isn't an issue with the current MUI tables, because we only query by one column at a time, but I noticed if I manually queried by multiple columns it would not function as expected, getting way too many results.
• Removed unused properties from schemas. Some of these were carried from old PIMS. Some have more recently been taken out or are about to be taken out in other PRs.
• Changed default error code to 500. If we don't know why something errored, it's not necessarily a bad request, but a server-side error.
• Removed hooks in react-app that were unused.

Testing

With the API running, go to this URL: http://localhost:5000/api-docs

To use any protected routes, copy your bearer token from the browser and use it in the authorization section

🔰 Checklist

• I have read and agree with the following checklist and am following the guidelines in our Code of Conduct document.

• I have performed a self-review of my code.
• I have commented my code, particularly in hard-to-understand areas.
• I have made corresponding changes to the documentation where required.
• I have tested my changes to the best of my ability.
• My changes generate no new warnings.

[github-actions]

🚀 Deployment Information

The Express API Image has been built with the tag: 2621. Please make sure to utilize this specific tag when promoting these changes to the TEST and PROD environments during the API deployment. For more updates please monitor Image Tags Page on Wiki.

[codeclimate]

Code Climate has analyzed commit b955e59 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 83.7% (50% is the threshold).

This pull request will bring the total coverage in the repository to 93.2%.

View more on Code Climate.

[LawrenceLau2020]

The new swagger docs looks good, tested a couple endpoints and works well.
Also tested admin areas, agencies, properties and projects tables, filtering still working well and cancelling/resending notifications updates the updatedById correctly. No issues found.