docs(openapi): add examples for analysis endpoints

[Neelr1912]

📝 Description

This PR adds OpenAPI request and response examples for the analysis endpoints to improve the Swagger UI experience and make it easier for users to test the API using the built-in "Try it out" feature.

🚀 Endpoints Covered

• /explanation/
• /debugging/
• /suggestions/
• /analyze/

✨ Changes Made

• Added request payload examples for CodeRequest

• Added realistic response examples for:

  • ExplanationResponse
  • DebuggingResponse
  • SuggestionsResponse
  • AnalyzeResponse
  • ZipAnalyzeResponse

• Configured examples using Pydantic v2 schema metadata (json_schema_extra)

• Improved Swagger UI documentation and usability

✅ Verification

• OpenAPI schema generation verified successfully
• Swagger UI displays example request/response payloads
• Endpoint tests passed (55/55)
• No changes to API functionality or business logic

Fixes #205

[Neelr1912]

Hi @imDarshanGK,

I've implemented the OpenAPI examples for the analysis endpoints as requested in #205.

Changes

• Added request example for CodeRequest

• Added response examples for:

  • ExplanationResponse
  • DebuggingResponse
  • SuggestionsResponse
  • AnalyzeResponse
  • ZipAnalyzeResponse

Verification

• OpenAPI schema generated successfully
• Swagger UI displays examples correctly
• Endpoint tests passed locally (55/55)

Could you please review the PR and approve the pending workflows when convenient?

Thank you!

[github-actions]

👋 This PR has had no activity for 7 days.

Please push updates or comment if you still need more time.

Inactive PRs may be closed automatically after 7 more days.

[Neelr1912]

give me some time

[Neelr1912]

Hi @imDarshanGK,

Just following up on this PR.

The branch has been updated with the latest main branch and is ready for review. It appears that the remaining checks are currently waiting for maintainer approval before the workflows can run.

Whenever convenient, could you please review the PR and approve the pending workflows?

If any changes or improvements are required, I'd be happy to address them.

Thank you for your time and support!

[imDarshanGK]

@Neelr1912

[Neelr1912]

"Hi @imDarshanGK, I have formatted schemas.py with black and isort and pushed the updates. The formatting/lint checks should pass now. Could you please approve the workflows to run?"