-
Notifications
You must be signed in to change notification settings - Fork 3
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
feat: update RetryEncode api #99
Conversation
Reviewer's Guide by SourceryThis pull request updates the RetryEncode API by removing the Sequence diagram for the simplified RetryEncode task flowsequenceDiagram
participant User
participant TaskComponent
participant RetryEncodeAPI
User->>TaskComponent: Click retry encode
TaskComponent->>TaskComponent: Show confirmation dialog
User->>TaskComponent: Confirm retry
TaskComponent->>RetryEncodeAPI: RetryEncodeTask(video_key, index, timeout, queue)
Note over RetryEncodeAPI: No longer requires encode_param and script
Class diagram showing changes to RetryEncodeTaskRequest interfaceclassDiagram
class RetryEncodeTaskRequest {
+string video_key
+number index
+number timeout (optional)
+string queue (optional)
+any [property: string]
}
note for RetryEncodeTaskRequest "Removed encode_param and script fields"
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Hey @Tohrusky - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
video_key: string | ||
index: number | ||
timeout?: number | ||
queue?: string | ||
[property: string]: any |
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.
suggestion: Consider removing the index signature to make the interface more type-safe
Since encode_param and script are being removed, it seems the interface is becoming more specific. The index signature allowing arbitrary properties could mask potential errors. Consider making the interface strict by removing [property: string]: any.
Summary by Sourcery
New Features:
RetryEncodeTask
API.