feat: add Scalar API docs and comprehensive CI/CD pipeline#35
Open
karanray06 wants to merge 1 commit intopollinations:mainfrom
Open
feat: add Scalar API docs and comprehensive CI/CD pipeline#35karanray06 wants to merge 1 commit intopollinations:mainfrom
karanray06 wants to merge 1 commit intopollinations:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds interactive API documentation and a code quality pipeline to lixSearch.
API Documentation: A complete OpenAPI specification (openapi.yaml) has been added, and the Scalar UI is now integrated. You can view and test all API endpoints by going to /docs while the app is running.
CI/CD Pipeline: A GitHub Actions workflow has been added. It automatically checks every Pull Request for: - Python code formatting (Black, Isort) - Logic and style errors (Flake8) - Security vulnerabilities (Bandit, Safety) - Type accuracy (Mypy) - Docker build stability These changes help keep the project easy to document and ensure that new contributions do not break existing functionality.