[ Documentation ] Document and collection routes

[jerome-white]

Summary

Target issue is #180

Add documentation for document and collection routes

Checklist

Before submitting a pull request, please ensure that you mark these task.

• Ran fastapi run --reload app/main.py or docker compose up in the repository root and test.
• If you've fixed a bug or added code that is tested and has test cases.

Notes

Documentation is structured in two ways:

1. Parameter documentation is placed directly in the description tags. This goes for "simple" types in the router definition parameter list, and for "complex" types defined as classes composed of simple types. Notably, these descriptions are placed within the Python source files.
2. Route documentation exists in standalone Markdown files. They are loaded via a custom function that knows where they live in the codebase.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!