feat: Enhanced API documentation, security practices, and table management #24
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
## Summary This commit refines the type checking process and removes unused example files, enhancing project organization and maintainability. ## Key Changes - Updated the type checking command in the `justfile` to use `basedpyright` for improved type analysis. - Removed several unused example files and their corresponding README, streamlining the codebase. - Added new type checking configurations in `pyproject.toml` to suppress specific type report warnings. ## Testing Notes - Ensure that type checking runs successfully with the new configuration. - Verify that the project builds correctly after the removal of example files. ## Infrastructure Considerations The cleanup of unused files reduces clutter, making the project easier to navigate for developers.
## Summary This commit updates the API documentation for various endpoints and enhances file management functionalities, improving clarity and usability. ## Key Changes - Revised example requests and responses in the `create_graph`, `get_available_extensions`, `get_graphs`, and `select_graph` endpoints to reflect updated entity names and descriptions. - Enhanced documentation for file management operations, including `delete_file`, `get_file_info`, `get_upload_url`, and `update_file_status`, to provide clearer usage instructions and examples. - Improved the handling of file statuses and upload processes, ensuring better validation and error reporting. ## Testing Notes - Verify that the updated documentation accurately reflects the API behavior. - Test file management operations to ensure they function as expected with the new documentation. ## Infrastructure Considerations The documentation updates and enhancements to file management features will improve developer experience and reduce confusion during API integration.
## Summary This commit updates the API documentation across various endpoints and reinforces security best practices for query execution. ## Key Changes - Added detailed documentation on using parameterized queries to prevent injection attacks in `execute_cypher_query`, `query_tables`, and `table_query_request`. - Revised the `export_graph_schema` and `get_graph_schema` endpoints to clarify the distinction between declared and runtime schemas, including examples of usage. - Removed the deprecated `GetGraphSchemaResponseGetgraphschema` model to streamline the codebase. ## Testing Notes - Verify that the updated documentation accurately reflects the API behavior and security practices. - Test all affected endpoints to ensure they function correctly with the new documentation. ## Infrastructure Considerations These enhancements improve developer experience and security, reducing the risk of injection vulnerabilities during query execution.
This commit updates the `_parse_response` function to handle NDJSON responses more effectively. If the response's content type indicates NDJSON, the function will now return `None` instead of attempting to parse the response as JSON. This change improves the robustness of the query execution process when dealing with different response formats. Testing Notes: - Verify that the function correctly identifies and handles NDJSON responses without errors. - Ensure that other response types continue to be processed as expected.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This PR introduces significant improvements to the robosystems client with enhanced API documentation, improved security practices, streamlined file management, and better NDJSON response handling for Cypher queries.
Key Accomplishments
🔧 API Enhancements
execute_cypher_queryto better handle NDJSON responses with more robust parsing and error handling🔒 Security Improvements
🧹 Code Quality & Maintenance
📁 File Management
basic_query.py,e2e_workflow.py) that were outdatedBreaking Changes
examples/directory - users should refer to updated API documentation for usage patternsTesting Notes
Infrastructure Considerations
This release significantly improves the developer experience with better documentation, enhanced security, and more reliable API interactions while maintaining backward compatibility for core functionality.
🤖 Generated with Claude Code
Branch Info:
feature/improved-graph-tablesmainCo-Authored-By: Claude noreply@anthropic.com