Skip to content

Commit bb295bf

Browse files
jfrench9claude
andauthored
feat: Enhanced API documentation, security practices, and table management (#24)
## 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 - **Enhanced NDJSON Response Handling**: Improved `execute_cypher_query` to better handle NDJSON responses with more robust parsing and error handling - **Comprehensive API Documentation**: Updated documentation across all API endpoints (106 files) with improved parameter descriptions, response schemas, and usage examples - **Table API Refactoring**: Simplified naming conventions and enhanced functionality for table management operations ### 🔒 Security Improvements - **Enhanced Security Practices**: Implemented improved authentication handling and security best practices across all API endpoints - **SSO Token Generation**: Refined SSO token handling mechanisms for better security compliance ### 🧹 Code Quality & Maintenance - **Type Checking Refactor**: Improved type annotations and checking throughout the codebase for better code reliability - **Project Cleanup**: Removed outdated example files and documentation to reduce maintenance burden and confusion - **Extension Updates**: Enhanced client extensions including auth integration, query client, SSE client, and table ingest functionality ### 📁 File Management - **Streamlined Examples**: Removed legacy example files (`basic_query.py`, `e2e_workflow.py`) that were outdated - **Updated Build Configuration**: Enhanced project configuration and CI/CD pipeline improvements ## Breaking Changes - Removed example files from the `examples/` directory - users should refer to updated API documentation for usage patterns - Table API naming conventions have been simplified (see commit #23 for details) ## Testing Notes - All existing API functionality has been preserved while enhancing documentation and security - NDJSON response handling improvements should be tested with various Cypher query response formats - Updated CI/CD pipeline includes additional validation steps ## Infrastructure Considerations - Version bump to v0.2.3 includes all stability improvements - Enhanced error handling may affect downstream error processing logic - Improved type checking may surface previously hidden type-related issues during development 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](https://claude.ai/code) **Branch Info:** - Source: `feature/improved-graph-tables` - Target: `main` - Type: feature Co-Authored-By: Claude <noreply@anthropic.com>
2 parents a0f15c1 + 24d64cb commit bb295bf

File tree

106 files changed

+2851
-7399
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

106 files changed

+2851
-7399
lines changed

.github/workflows/test.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,7 @@ jobs:
3737
- name: Run Lint
3838
run: |
3939
uv run ruff check .
40+
41+
- name: Run type checking
42+
run: |
43+
uv run basedpyright

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@ pip install robosystems-client[tables]
2727
pip install robosystems-client[all]
2828
```
2929

30-
See the [examples](./examples) directory for usage guides.
31-
3230
## API Reference
3331

3432
- [API reference](https://api.robosystems.ai)

examples/README.md

Lines changed: 0 additions & 272 deletions
This file was deleted.

examples/basic_query.py

Lines changed: 0 additions & 99 deletions
This file was deleted.

0 commit comments

Comments
 (0)