Skip to content

Conversation

@mateuscardosodeveloper
Copy link
Contributor

@mateuscardosodeveloper mateuscardosodeveloper commented Dec 12, 2025

What does PR do?

📚 Complete Run Class Documentation & Testing Overhaul

This PR provides comprehensive documentation and testing coverage for the TagoIO Python SDK Run class, which manages TagoRUN environment configuration and user operations.

🎯 Key Improvements

Documentation Enhancements:

  • Complete docstrings for all 24 Run class methods with usage examples
  • Authorization guidance showing required Access Management policies for each operation
  • Help Center links connecting methods to relevant TagoIO documentation
  • Consistent formatting following project documentation standards
  • Real-world examples demonstrating practical implementation patterns

Testing Infrastructure:

  • 17 comprehensive test cases covering all Run class methods
  • Mocked API responses using requests-mock for reliable testing
  • Full coverage for user management, notifications, SSO, and custom domains
  • Validation tests ensuring correct data structures and return types

Type Safety:

  • New EmailTestData TypedDict for type-safe email testing
  • Updated type hints replacing generic TypedDict with Dict where appropriate
  • Improved parameter flexibility for edit operations

🧪 Testing Highlights

All tests include:

  • Proper token authentication setup
  • Realistic API response mocking
  • Assertion validation for expected return types
  • Edge case coverage for error scenarios

📖 Documentation Structure

Each method now includes:

  • @description - Clear method purpose
  • @see - Help Center documentation links
  • @example - Working code samples with expected output
  • Authorization policy guidance for troubleshooting "Authorization Denied" errors

This PR ensures developers have clear, actionable documentation and reliable tests for all TagoRUN operations! 🚀

JIRA cards

Type of alteration

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Add detailed docstrings for all Run class methods with usage examples and authorization policy references. Include new EmailTestData type for email testing functionality. Implement comprehensive test suite covering all Run methods with mocked API responses.
Update RST documentation with detailed method descriptions, usage examples, and authorization policy references. Add EmailTestData type documentation and restructure all Run method docs with consistent formatting and Help Center links.
@mateuscardosodeveloper mateuscardosodeveloper changed the base branch from main to feat/update-class-profile/SDKPY-149 December 12, 2025 18:28
@mateuscardosodeveloper mateuscardosodeveloper added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants