docs: fix README timeout defaults and add http_delete body param - #279
Merged
Merged
Conversation
Contributor
|
hey @bookingminds I took the liberty of fixing the minor comment on the Pr. Hope thats ok . Rest all looks good to me. Going ahead with the merge. |
utkarash2991
approved these changes
Sep 10, 2026
Contributor
Author
|
Thanks for catching that and for fixing it yourself rather than bouncing |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
Docs update. The README's published function signatures do not match the shipped functions.
What is the current behavior?
The README documents timeout_milliseconds int default 1000 for net.http_get and net.http_post, and default 2000 for net.http_delete. It also shows net.http_delete without a body parameter.
What is the new behavior?
All three signatures show timeout_milliseconds int default 5000, and net.http_delete includes its body parameter, matching sql/pg_net.sql on master:
create or replace function net.http_delete(
url text,
params jsonb default '{}'::jsonb,
headers jsonb default '{}'::jsonb,
timeout_milliseconds int default 5000,
body jsonb default null
)
Additional context
The same two errors, with a different wrong timeout value, appear in the Supabase docs guide for pg_net. I opened a separate PR for that page.