Skip to content

feat: add initial Flask-Smorest OpenAPI configuration - #207

Closed
Shikha18Shukla wants to merge 1 commit into
Him-an-shi:mainfrom
Shikha18Shukla:feature/swagger-api-docs
Closed

feat: add initial Flask-Smorest OpenAPI configuration#207
Shikha18Shukla wants to merge 1 commit into
Him-an-shi:mainfrom
Shikha18Shukla:feature/swagger-api-docs

Conversation

@Shikha18Shukla

@Shikha18Shukla Shikha18Shukla commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

📌 Summary

This PR adds the initial Flask-Smorest/OpenAPI configuration to the backend, laying the foundation for future Swagger API documentation without changing any existing API behavior.

✨ Changes Made

  • Added Flask-Smorest integration.

  • Configured OpenAPI metadata:

    • API_TITLE
    • API_VERSION
    • OPENAPI_VERSION
  • Configured Swagger UI endpoint (/docs).

  • Initialized the Flask-Smorest Api object.

  • Prepared the backend for future API documentation using Flask-Smorest.

🧪 Testing

  • Backend starts successfully after the configuration changes.
  • Existing API functionality remains unchanged.

📋 Notes

The current backend defines its routes directly using @app.route, so automatic endpoint documentation will require a future migration to Flask-Smorest Blueprints. This PR focuses on establishing the initial OpenAPI configuration as the first step toward that goal.

Closes #207

@vercel

vercel Bot commented Jul 27, 2026

Copy link
Copy Markdown

@Shikha18Shukla is attempting to deploy a commit to the himanshipathak-240263-3015's projects Team on Vercel.

A member of the Team first needs to authorize it.

@Shikha18Shukla

Copy link
Copy Markdown
Contributor Author

Hi! @Him-an-shi , I checked the failing Quality Gate, and it looks like the failure is due to the GitHub Actions workflow rather than the changes in this PR. The workflow is using pull_request_target, and GitHub is refusing to check out code from a fork for security reasons. From the logs:

Refusing to check out fork pull request code from a pull_request_target workflow.

I don't think this is something I can resolve from my fork. Please let me know if you'd like me to make any changes on my side.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants