Refactor and clean up URLs and endpoints

[dhruvkb]

Dependencies

Please merge #160 before this.

Description

This is a refactoring PR that cleans up, reorganises and in general improves the code quality of the endpoints. These refactors are made possible thanks to the confidence of the more comprehensive integration tests.

Technical details

The PR makes the following improvements:

• Cleans up the URL config
  • Breaks it into more digestible chunks
  • Organises related endpoints together
  • Deprecates old endpoints, with backwards-compatible permanent redirects
• Disables the caching for Swagger documentation in dev (no need to repeatedly clean cache to see changes now!)
• Adheres to Django conventions about settings, path/re_path and include

Checklist

• My pull request has a descriptive title (not a vague title like Update index.md).
• My pull request targets the default branch of the repository (main or master).
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• I added or updated tests for the changes I made (if applicable).
• I added or updated documentation (if applicable).
• I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

[zackkrida]

You almost removed as much code as was added 😄 this looks good to me! appreciate the new test for deprecated endpoints.

[dhruvkb]

@zackkrida by cleaning up I meant breaking up and reorganising big files into smaller modules.

[zackkrida]

Yes, I just noticed the diff—this is absolutely much cleaner regardless of LOC

[obulat]

Great changes. Nice to see code cleaned up :)