📚 Improve API Documentation with Examples

[skdas20]

📖 Issue Description

The API documentation needs improvement with better examples, request/response schemas, and usage guides.

🎯 Goals

• Add comprehensive API examples
• Improve OpenAPI/Swagger documentation
• Create usage tutorials
• Add error response documentation

📋 Tasks

• Add detailed docstrings to all API endpoints
• Create request/response examples for each endpoint
• Add error response documentation
• Create API usage tutorial
• Add Postman collection
• Improve FastAPI schema descriptions

🛠️ Technical Details

• Update FastAPI endpoint docstrings
• Add Pydantic model descriptions
• Create example requests and responses
• Add tags and metadata for better organization

📚 Deliverables

• Updated API documentation
• Postman collection file
• API usage tutorial in docs folder
• Example code snippets

🏷️ Skills Required

• FastAPI knowledge
• Documentation writing
• API design understanding
• Markdown

[Ananyashakya]

Hi @maintainer 👋

I'm Ananya, contributing as part of GSSoC'25, and I’d love to work on improving the API documentation for this project.

📌 My Plan:

• Add clear and consistent docstrings for all FastAPI endpoints
• Define complete request/response examples for each route
• Document all potential error responses with proper status codes and messages
• Add descriptive metadata and tags for better Swagger/OpenAPI structure
• Create an easy-to-follow API usage tutorial in the docs/ folder
• Provide a Postman collection for quick local testing
• Add example code snippets and improve Pydantic model descriptions for clarity

I'm comfortable working with FastAPI, Pydantic, and Markdown-based docs, and I’ll ensure the updates are clean, readable, and beginner-friendly.

👉 Kindly assign this issue to me if it's unclaimed. Also, please consider adding labels like level: for tracking under GSSoC'25.

Looking forward to contributing and improving the developer experience for this project!