totp_verification_url in the task creation API and task cancel API documentation #605
Conversation
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
There was a problem hiding this comment.
❌ Changes requested. Reviewed everything up to 3905e17 in 42 seconds
More details
- Looked at
47lines of code in1files - Skipped
0files when reviewing. - Skipped posting
0drafted comments based on config settings.
Workflow ID: wflow_LVHRFY2YCg7SCIL2
Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
docs/running-tasks/api-spec.mdx
Outdated
|
|
||
| Response: | ||
| | Parameter | Type | Required? | Sample Value | Description | | ||
| | task_id | String | yes | tsk_123 | The task ID that needs the verification to be done | |
There was a problem hiding this comment.
The response table for the TOTP endpoint incorrectly lists task_id twice. It should only include verification_code as a response parameter.
| | task_id | String | yes | tsk_123 | The task ID that needs the verification to be done | | |
| | verification_code | String | no | 123456 | The verification code | |
There was a problem hiding this comment.
❌ Changes requested. Incremental review on b5964a1 in 59 seconds
More details
- Looked at
91lines of code in3files - Skipped
0files when reviewing. - Skipped posting
0drafted comments based on config settings.
Workflow ID: wflow_4ERuj6Dymu3wpQcL
Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.
| Response: | ||
| | Parameter | Type | Required? | Sample Value | Description | | ||
| | task_id | String | yes | tsk_123 | The task ID that needs the verification to be done | | ||
| | verification_code | String | no | 123456 | The verification code | |
There was a problem hiding this comment.
The verification_code parameter in the response should be marked as required. Without a verification code, the TOTP process cannot be completed effectively.
| | verification_code | String | no | 123456 | The verification code | | |
| | verification_code | String | yes | 123456 | The verification code | |
Summary:
Added documentation for
totp_verification_url, TOTP endpoint setup, task cancellation API, and included a Python example for validating request signatures.Key points:
totp_verification_urlparameter to task creation API documentation indocs/running-tasks/api-spec.mdx.docs/running-tasks/totp-verification-code.mdx.docs/running-tasks/totp-verification-code.mdx.docs/running-tasks/api-spec.mdx.docs/mint.jsonto include the new TOTP documentation page.Generated with ❤️ by ellipsis.dev