Skip to content

feat(client): add placeholder methods for unimplemented API endpoints#88

Open
briansumma wants to merge 1 commit intoNorthShoreAutomation:mainfrom
briansumma:feature/add-placeholder-endpoints
Open

feat(client): add placeholder methods for unimplemented API endpoints#88
briansumma wants to merge 1 commit intoNorthShoreAutomation:mainfrom
briansumma:feature/add-placeholder-endpoints

Conversation

@briansumma
Copy link
Copy Markdown
Contributor

Summary

Adds placeholder methods for API endpoints that haven't been implemented yet, improving discoverability and providing a clear development roadmap.

Notes for reviewer

  • The changes maintain full backward compatibility - all existing functionality
    remains unchanged, only adding new placeholder methods
  • I would merge this into main before merging feature/acls and feature/transcode;
    although you may still get some merge conflicts in the client.py file that you will
    have to resolve

Changes

  • Added 9 placeholder endpoint methods to PythonikClient:
    • acls() - Access Control Lists
    • auth() - Authentication
    • automations() - Workflow automations
    • notifications() - System notifications
    • settings() - Configuration settings
    • stats() - Analytics and statistics
    • transcode() - Media transcoding
    • users() - User management
    • users_notifications() - User-specific notifications

Implementation Details

  • Each placeholder raises NotImplementedError with descriptive messages
  • Consistent docstring format explaining the endpoint purpose
  • Error messages guide users to documentation and contribution opportunities
  • Maintains same method signature pattern as implemented endpoints

Benefits

  • Discoverability: Users can see all planned endpoints via IDE autocomplete
  • Documentation: Clear indication of what each endpoint will provide
  • Consistency: Follows established patterns from existing endpoints
  • Contribution: Makes it easy for contributors to identify implementation opportunities

Testing

  • No breaking changes - purely additive
  • Existing functionality remains unchanged
  • New methods properly raise NotImplementedError as expected

Add placeholder methods for acls, auth, automations, notifications,
settings, stats, transcode, users, and users_notifications endpoints.
Each placeholder raises NotImplementedError with descriptive messages
to guide users and contributors.

- Improves API discoverability through IDE autocomplete
- Provides clear roadmap for future endpoint implementations
- Maintains consistent interface pattern with existing endpoints
- Includes helpful error messages directing users to documentation

Breaking change: None (additive changes only)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant