Closed andrea-williams closed 5 months ago
Suggest adding tags to endpoints to make our OpenAPI docs more organized: https://django-ninja.dev/reference/operations-parameters/?h=tags#tags
Endpoint naming best practices: https://www.geeksforgeeks.org/best-practices-for-naming-api-endpoints-in-a-restful-architecture/ (from Sepehr)
Description of the Tech Debt
Blocked on endpoint renaming: #1077
We stopped adding any documentation for our API endpoints months ago, and because of that our Swagger docs are extremely lackluster. This is very inconsiderate to any future developers, and also will impact current devs in the long-term.
Tech Debt Triage
The purpose of our technical debt triage process is to analyze technical debt to determine risk level of the technical debt and the value in tackling that technical debt.
Risk Value Scoring: