docs: doc guidelines in router template

This commit is contained in:
Chris Milne 2026-05-28 16:03:33 +01:00
parent ff4d36b4cd
commit f60d86e91d

View file

@ -3,6 +3,19 @@ Router endpoints for the <this> module
Exports:
- router: fastapi.APIRouter
### Router Guidelines ###
- Add responses to decorators
- Add status_codes to decorators
- All endpoints should either return a response object or 204
- Ensure response_model is declared in the decorator
- All query and path params should have validation and descriptions
- All endpoints should have a docstring (this is used in place of a description)
- All endpoints should have a summary
- All modules should have metadata in main.py
- All exceptions should have a custom definition in exceptions.py
- Dependencies should be used for db model get and validation where possible
- Verify module level docstring is still accurate after updates
"""
from fastapi import APIRouter