-
Notifications
You must be signed in to change notification settings - Fork 0
feat: Custom operations on Documents and Parts #40
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…o event documentation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request adds support for custom operations on documents and parts by introducing two new event types: CustomOperationDocumentEvent and CustomOperationPartEvent. These events allow users to trigger custom Python functions when performing operations on documents or parts in the CIM Database Cloud.
- Adds new event schemas and Python event classes for custom operations on documents and parts
- Updates documentation to describe the new events and their usage
- Provides a practical example showing how to generate and attach reports to documents using custom operations
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Adds navigation entry for the new basic_report example |
| json_schemas/request.json | Defines JSON schemas for CustomOperationDocumentEvent and CustomOperationPartEvent with their data structures |
| docs/reference/events.md | Documents the new custom operation events, including supported actions and data attributes |
| docs/examples/basic_report.md | Provides a complete example demonstrating custom operations by generating Word reports for documents |
| csfunctions/events/custom_operations.py | Implements Python classes for the custom operation events and their data models |
| csfunctions/events/base.py | Adds event name constants for the new custom operation events |
| csfunctions/events/init.py | Exports the new event types and integrates them into the Event union type |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Add support for custom operations on documents and parts