From e0acbc6b75bb7111d245c0858bd92cbff222b5dd Mon Sep 17 00:00:00 2001 From: 0x676e67 Date: Thu, 21 May 2026 14:59:10 +0800 Subject: [PATCH 1/2] docs(lib): remove invalid parameters in request method docs --- lib/wreq.rb | 82 ++++++++++++++----------------- lib/wreq_ruby/client.rb | 104 ++++++++++++++++++++-------------------- 2 files changed, 88 insertions(+), 98 deletions(-) diff --git a/lib/wreq.rb b/lib/wreq.rb index 25be38f..f577e08 100644 --- a/lib/wreq.rb +++ b/lib/wreq.rb @@ -28,13 +28,10 @@ module Wreq # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Array, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow # @param gzip [Boolean, nil] Enable gzip compression @@ -44,11 +41,13 @@ module Wreq # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param no_proxy [Boolean, nil] Disable proxy for this request # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def self.request(method, url, **options) end @@ -60,13 +59,10 @@ def self.request(method, url, **options) # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Array, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow # @param gzip [Boolean, nil] Enable gzip compression @@ -76,11 +72,13 @@ def self.request(method, url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param no_proxy [Boolean, nil] Disable proxy for this request # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def self.get(url, **options) end @@ -92,16 +90,12 @@ def self.get(url, **options) # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Array, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow - # @param gzip [Boolean, nil] Enable gzip compression # @param brotli [Boolean, nil] Enable Brotli compression # @param deflate [Boolean, nil] Enable deflate compression @@ -109,11 +103,13 @@ def self.get(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param no_proxy [Boolean, nil] Disable proxy for this request # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def self.head(url, **options) end @@ -125,13 +121,10 @@ def self.head(url, **options) # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Array, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow # @param gzip [Boolean, nil] Enable gzip compression @@ -141,11 +134,13 @@ def self.head(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param no_proxy [Boolean, nil] Disable proxy for this request # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def self.post(url, **options) end @@ -157,13 +152,10 @@ def self.post(url, **options) # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Array, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow # @param gzip [Boolean, nil] Enable gzip compression @@ -173,11 +165,13 @@ def self.post(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param no_proxy [Boolean, nil] Disable proxy for this request # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def self.put(url, **options) end @@ -189,13 +183,10 @@ def self.put(url, **options) # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Array, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow # @param gzip [Boolean, nil] Enable gzip compression @@ -205,11 +196,13 @@ def self.put(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param no_proxy [Boolean, nil] Disable proxy for this request # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def self.delete(url, **options) end @@ -221,13 +214,10 @@ def self.delete(url, **options) # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Array, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow # @param gzip [Boolean, nil] Enable gzip compression @@ -237,11 +227,13 @@ def self.delete(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param no_proxy [Boolean, nil] Disable proxy for this request # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def self.options(url, **options) end @@ -253,13 +245,10 @@ def self.options(url, **options) # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Array, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow # @param gzip [Boolean, nil] Enable gzip compression @@ -269,11 +258,13 @@ def self.options(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param no_proxy [Boolean, nil] Disable proxy for this request # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def self.trace(url, **options) end @@ -285,13 +276,10 @@ def self.trace(url, **options) # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Array, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow # @param gzip [Boolean, nil] Enable gzip compression @@ -301,11 +289,13 @@ def self.trace(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param no_proxy [Boolean, nil] Disable proxy for this request # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def self.patch(url, **options) end diff --git a/lib/wreq_ruby/client.rb b/lib/wreq_ruby/client.rb index a9d9414..26df59e 100644 --- a/lib/wreq_ruby/client.rb +++ b/lib/wreq_ruby/client.rb @@ -240,13 +240,10 @@ def self.new(**options) # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Hash{String=>String}, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow # @param gzip [Boolean, nil] Enable gzip compression @@ -260,6 +257,9 @@ def self.new(**options) # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def request(method, url, **options) end @@ -271,13 +271,10 @@ def request(method, url, **options) # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Hash{String=>String}, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow # @param gzip [Boolean, nil] Enable gzip compression @@ -287,10 +284,13 @@ def request(method, url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful to originate GET requests from a specific address. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable. - # @param interface [String, nil] Bind the socket to a network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Supported on Linux/Android/Fuchsia; typically requires privileges. + # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. + # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def get(url, **options) end @@ -302,13 +302,10 @@ def get(url, **options) # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Hash{String=>String}, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow # @param gzip [Boolean, nil] Enable gzip compression @@ -318,10 +315,13 @@ def get(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful to originate HEAD requests from a specific address. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". - # @param interface [String, nil] Bind the socket to a network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). + # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. + # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def head(url, **options) end @@ -333,13 +333,10 @@ def head(url, **options) # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Hash{String=>String}, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow # @param gzip [Boolean, nil] Enable gzip compression @@ -349,10 +346,13 @@ def head(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful to originate POST requests from a specific address. - # @param interface [String, nil] Bind the socket to a network interface via `SO_BINDTODEVICE`. + # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. + # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def post(url, **options) end @@ -364,13 +364,10 @@ def post(url, **options) # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Hash{String=>String}, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow # @param gzip [Boolean, nil] Enable gzip compression @@ -380,10 +377,13 @@ def post(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful to originate PUT requests from a specific address. - # @param interface [String, nil] Bind the socket to a network interface via `SO_BINDTODEVICE`. + # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. + # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def put(url, **options) end @@ -395,13 +395,10 @@ def put(url, **options) # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Hash{String=>String}, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow # @param gzip [Boolean, nil] Enable gzip compression @@ -411,10 +408,13 @@ def put(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful to originate DELETE requests from a specific address. - # @param interface [String, nil] Bind the socket to a network interface via `SO_BINDTODEVICE`. + # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. + # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def delete(url, **options) end @@ -426,13 +426,10 @@ def delete(url, **options) # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Hash{String=>String}, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow # @param gzip [Boolean, nil] Enable gzip compression @@ -442,10 +439,13 @@ def delete(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful to originate OPTIONS requests from a specific address. - # @param interface [String, nil] Bind the socket to a network interface via `SO_BINDTODEVICE`. + # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. + # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def options(url, **options) end @@ -457,13 +457,10 @@ def options(url, **options) # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Hash{String=>String}, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow # @param gzip [Boolean, nil] Enable gzip compression @@ -473,10 +470,13 @@ def options(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful to originate OPTIONS requests from a specific address. - # @param interface [String, nil] Bind the socket to a network interface via `SO_BINDTODEVICE`. + # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. + # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def trace(url, **options) end @@ -488,13 +488,10 @@ def trace(url, **options) # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified) # @param default_headers [Hash{String=>String}, nil] Default headers to merge # @param query [Hash, nil] URL query parameters - # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) - # @param json [Object, nil] JSON body (will be serialized) - # @param body [String, IO, nil] Raw request body (string or stream) # @param auth [String, nil] Authorization header value # @param bearer_auth [String, nil] Bearer token for Authorization header # @param basic_auth [Array, nil] Username and password for basic auth - # @param cookies [Hash{String=>String}, nil] Cookies to send + # @param cookies [Hash{String=>String}, String, nil] Cookies to send # @param allow_redirects [Boolean, nil] Whether to follow redirects # @param max_redirects [Integer, nil] Maximum number of redirects to follow # @param gzip [Boolean, nil] Enable gzip compression @@ -504,10 +501,13 @@ def trace(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful to originate OPTIONS requests from a specific address. - # @param interface [String, nil] Bind the socket to a network interface via `SO_BINDTODEVICE`. + # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. + # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use + # @param form [Hash{String=>String}, nil] Form data (application/x-www-form-urlencoded) + # @param json [Object, nil] JSON body (will be serialized) + # @param body [String, IO, nil] Raw request body (string or stream) # @return [Wreq::Response] HTTP response def patch(url, **options) end From 429c337ac75fac8deb3b1297642d255077202bd0 Mon Sep 17 00:00:00 2001 From: 0x676e67 Date: Thu, 21 May 2026 15:05:57 +0800 Subject: [PATCH 2/2] Update client.rb --- lib/wreq_ruby/client.rb | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/lib/wreq_ruby/client.rb b/lib/wreq_ruby/client.rb index 26df59e..2dc5f23 100644 --- a/lib/wreq_ruby/client.rb +++ b/lib/wreq_ruby/client.rb @@ -253,7 +253,7 @@ def self.new(**options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. + # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use @@ -284,7 +284,7 @@ def request(method, url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. + # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use @@ -315,7 +315,7 @@ def get(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. + # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use @@ -346,7 +346,7 @@ def head(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. + # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use @@ -377,7 +377,7 @@ def post(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. + # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use @@ -408,7 +408,7 @@ def put(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. + # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use @@ -439,7 +439,7 @@ def delete(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. + # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use @@ -470,7 +470,7 @@ def options(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. + # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use @@ -501,7 +501,7 @@ def trace(url, **options) # @param timeout [Integer, nil] Total request timeout (seconds) # @param read_timeout [Integer, nil] Per-chunk read timeout (seconds) # @param proxy [String, nil] Proxy server URI - # @param local_address [String, nil] Bind the client's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. + # @param local_address [String, nil] Bind the request's local source IP address (IPv4/IPv6). Useful on multi-homed hosts to originate connections from a specific address or enforce source routing. Examples: "192.168.1.10", "10.0.0.5", "2001:db8::1". The address must exist on the host and be routable or the connection may fail. # @param interface [String, nil] Bind the socket to a specific network interface via `SO_BINDTODEVICE` (e.g., "eth0", "wlan0", "tun0"). Effective only on systems that support the option (Linux/Android/Fuchsia) and typically requires privileges (root or CAP_NET_ADMIN). # @param emulation [Wreq::Emulation, nil] Device/OS emulation for this request # @param version [Wreq::Version, nil] HTTP version to use