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

Fix /api/docs endpoint [8] #2619

Open
2 tasks
andrea-williams opened this issue Dec 18, 2024 · 0 comments
Open
2 tasks

Fix /api/docs endpoint [8] #2619

andrea-williams opened this issue Dec 18, 2024 · 0 comments
Assignees

Comments

@andrea-williams
Copy link
Contributor

Description of the Tech Debt

Our /api/docs endpoint is returning an error message saying "TypeError: keys must be str, int, float, bool or None, not module".

It's very helpful to have our API documentation available at this endpoint, so we should fix it.

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:

Level Value
High
3
Medium
2
Low
1
Technical Debt - Risk Types Level Value
Business Area Risk - Risk of business area visibility / damage to user experience 0 1
Developer Fault Risk - How likely will this tech debt cause a future error related to coding on top of it 0 2
System Fault Risk - Risk of system errors or application downtime 0 1
Time Scale Risk - Compound risk effect if left alone. How much more difficult to fix or dangerous will this become over time? 0 2
Time Sink Risk - How much will this tech debt slow the development process down 0 2
TOTAL SCORE:
0 8

Development Checklist:

  • fix issue so that localhost:8000/api/docs displays our API documentation
  • (if possible) add test that ensures that the /api/docs endpoint renders properly instead of returning an error
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants