Improve the generated openapi schema

[tony-nyagah]

What type of PR is this?

Check all applicable

• 🍕 Feature
• 🐛 Bug Fix
• 📝 Documentation
• 🧑‍💻 Refactor
• ✅ Test
• 🤖 Build or CI
• ❓ Other (please specify)

Related Issue :

• Resolve Enhance API documentation and examples hotosm/raw-data-api#219

What does this PR do?

This PR improves the OpenAPI schema documentation generated by the FastAPI code. Most of the code is generated after taking into account issues raised by Rate My OpenAPI and going through the documentation section of the generated report.

Consideration :

I have looked at resolving most of the issues but the one that states OpenAPI object must have non-empty "tags" array. proved to be a challenge. It seems that one requires rewriting a lot of code.

How to test?

• Clone the repo.
• Install by following the steps in docs/src/installation/docker.md or docs/src/installation/docker.md.
• Run locally and view routes at http://localhost:8000/v1/docs

Screenshots :

Original Rate My OpenAPI score: https://ratemyopenapi.com/report/e16d5882-ea59

Rate My OpenAPI score after modifications: https://ratemyopenapi.com/report/bee9539a-df5b-4f5d-8d15-c75d396a2dd9

Checklists:

Checklist before requesting review :

• 📖 Read the HOT Code of Conduct: https://docs.hotosm.org/code-of-conduct
• 👷‍♀️ Create small PRs. In most cases, this will be possible.
• ✅ Provide tests for your changes.
• 📝 Use descriptive commit messages.
• 📗 Update any related documentation and include any relevant screenshots.

[optional] What gif best describes this PR or how it makes you feel?