docs: Add HttpRequest effect and delay_seconds documentation#1144
docs: Add HttpRequest effect and delay_seconds documentation#1144promptless[bot] wants to merge 2 commits intomainfrom
Conversation
- Add new HTTP Request effect page documenting HttpRequest class for making HTTP requests from plugins with effect chaining - Document delay_seconds parameter for async/delayed effect execution - Add HTTP_REQUEST to effect types table - Update navigation menu to include HTTP Request effect
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
| @@ -0,0 +1,132 @@ | |||
| --- | |||
There was a problem hiding this comment.
Created HttpRequest effect documentation based on HttpRequest class implementation in canvas_sdk/effects/http_request.py, including url, method, headers, body, on_success, and on_failure attributes from the PR.
| return [layout.apply()] | ||
| ``` | ||
|
|
||
| ### Delayed and Asynchronous Execution |
There was a problem hiding this comment.
Added delay_seconds parameter documentation based on the validate_delay_seconds decorator and updated effect methods in canvas_sdk/effects/base.py. The parameter supports None for sync execution, 0 for async, and positive integers for delayed async execution.
|
I noticed that some CI checks failed for this PR. I'm investigating whether the failures are caused by this suggestion. If they're unrelated or pre-existing, I'll leave this suggestion unchanged and create a separate suggestion if a standalone docs fix is needed. |
- Use python?partial=true for all code blocks to handle unreleased canvas_sdk.effects.http_request import - Remove return statement outside function in the "Chained Effects with Delays" snippet to fix SyntaxError
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
Open this suggestion in Promptless to view citations and reasoning process
Documents two new SDK capabilities: the HttpRequest effect for making HTTP requests from plugins with optional effect chaining based on response status, and the delay_seconds parameter for asynchronous or delayed effect execution across all effect methods. Backend implementation in PR #18918 (canvas-medical/canvas) complements the SDK changes from PR #1633 (canvas-medical/canvas-plugins).
https://canvasmedical.atlassian.net/browse/KOALA-4751
Tip: Tell your friends working on non-commercial open-source projects to apply for free Promptless access at promptless.ai/oss ❤️