playwright-ruby-client 1.28.0 → 1.29.0

data/lib/playwright_api/accessibility.rb

@@ -1,7 +1,4 @@
 module Playwright
-  # **DEPRECATED** This class is deprecated. Please use other libraries such as [Axe](https://www.deque.com/axe/) if you
-  # need to test page accessibility. See our Node.js [guide](https://playwright.dev/docs/accessibility-testing) for
-  # integration with Axe.
   #
   # The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by
   # assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or
@@ -10,23 +7,22 @@ module Playwright
   # Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might
   # have wildly different output.
   #
-  # Rendering engines of Chromium, Firefox and WebKit have a concept of "accessibility tree", which is then translated into
-  # different platform-specific APIs. Accessibility namespace gives access to this Accessibility Tree.
+  # Rendering engines of Chromium, Firefox and WebKit have a concept of "accessibility tree", which is then translated into different
+  # platform-specific APIs. Accessibility namespace gives access to this Accessibility Tree.
   #
-  # Most of the accessibility tree gets filtered out when converting from internal browser AX Tree to Platform-specific
-  # AX-Tree or by assistive technologies themselves. By default, Playwright tries to approximate this filtering, exposing
-  # only the "interesting" nodes of the tree.
+  # Most of the accessibility tree gets filtered out when converting from internal browser AX Tree to Platform-specific AX-Tree or by
+  # assistive technologies themselves. By default, Playwright tries to approximate this filtering, exposing only the
+  # "interesting" nodes of the tree.
   class Accessibility < PlaywrightApi
 
-    # **DEPRECATED** This method is deprecated. Please use other libraries such as [Axe](https://www.deque.com/axe/) if you
-    # need to test page accessibility. See our Node.js [guide](https://playwright.dev/docs/accessibility-testing) for
-    # integration with Axe.
     #
     # Captures the current state of the accessibility tree. The returned object represents the root accessible node of the
     # page.
     #
-    # > NOTE: The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers.
-    # Playwright will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`.
+    # **NOTE**: The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers. Playwright
+    # will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`.
+    #
+    # **Usage**
     #
     # An example of dumping the entire accessibility tree:
     #

data/lib/playwright_api/android.rb

@@ -1,10 +1,10 @@
 module Playwright
+  #
   # Playwright has **experimental** support for Android automation. This includes Chrome for Android and Android WebView.
   #
   # *Requirements*
   # - Android device or AVD Emulator.
-  # - [ADB daemon](https://developer.android.com/studio/command-line/adb) running and authenticated with your device.
-  #   Typically running `adb devices` is all you need to do.
+  # - [ADB daemon](https://developer.android.com/studio/command-line/adb) running and authenticated with your device. Typically running `adb devices` is all you need to do.
   # - [`Chrome 87`](https://play.google.com/store/apps/details?id=com.android.chrome) or newer installed on the device
   # - "Enable command line on non-rooted devices" enabled in `chrome://flags`.
   #
@@ -17,25 +17,27 @@ module Playwright
   #
   # An example of the Android automation script would be:
   #
-  # Note that since you don't need Playwright to install web browsers when testing Android, you can omit browser download
-  # via setting the following environment variable when installing Playwright:
+  # Note that since you don't need Playwright to install web browsers when testing Android, you can omit browser download via setting the following environment variable when installing Playwright:
   #
   # ```bash js
   # PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm i -D playwright
   # ```
   class Android < PlaywrightApi
 
-    # This methods attaches Playwright to an existing Android device. Use [`method: Android.launchServer`] to launch a new
-    # Android server instance.
+    #
+    # This methods attaches Playwright to an existing Android device.
+    # Use [`method: Android.launchServer`] to launch a new Android server instance.
     def connect(wsEndpoint, headers: nil, slowMo: nil, timeout: nil)
       raise NotImplementedError.new('connect is not implemented yet.')
     end
 
+    #
     # Returns the list of detected Android devices.
     def devices(host: nil, omitDriverInstall: nil, port: nil)
       wrap_impl(@impl.devices(host: unwrap_impl(host), omitDriverInstall: unwrap_impl(omitDriverInstall), port: unwrap_impl(port)))
     end
 
+    #
     # This setting will change the default maximum time for all the methods accepting `timeout` option.
     def set_default_timeout(timeout)
       raise NotImplementedError.new('set_default_timeout is not implemented yet.')

data/lib/playwright_api/android_device.rb

@@ -1,45 +1,53 @@
 module Playwright
-  # `AndroidDevice` represents a connected device, either real hardware or emulated. Devices can be obtained using
-  # [`method: Android.devices`].
+  #
+  # `AndroidDevice` represents a connected device, either real hardware or emulated. Devices can be obtained using [`method: Android.devices`].
   class AndroidDevice < PlaywrightApi
 
     def input # property
       wrap_impl(@impl.input)
     end
 
+    #
     # Disconnects from the device.
     def close
       wrap_impl(@impl.close)
     end
 
+    #
     # Drags the widget defined by `selector` towards `dest` point.
     def drag(selector, dest, speed: nil)
       raise NotImplementedError.new('drag is not implemented yet.')
     end
 
+    #
     # Fills the specific `selector` input box with `text`.
     def fill(selector, text)
       raise NotImplementedError.new('fill is not implemented yet.')
     end
 
+    #
     # Flings the widget defined by `selector` in  the specified `direction`.
     def fling(selector, direction, speed: nil)
       raise NotImplementedError.new('fling is not implemented yet.')
     end
 
+    #
     # Returns information about a widget defined by `selector`.
     def info(selector)
       wrap_impl(@impl.info(unwrap_impl(selector)))
     end
 
+    #
     # Installs an apk on the device.
     def install_apk(file, args: nil)
       raise NotImplementedError.new('install_apk is not implemented yet.')
     end
 
+    #
     # Launches Chrome browser on the device, and returns its persistent context.
     def launch_browser(
           acceptDownloads: nil,
+          args: nil,
           baseURL: nil,
           bypassCSP: nil,
           colorScheme: nil,
@@ -57,6 +65,7 @@ module Playwright
           noViewport: nil,
           offline: nil,
           permissions: nil,
+          proxy: nil,
           record_har_content: nil,
           record_har_mode: nil,
           record_har_omit_content: nil,
@@ -72,102 +81,123 @@ module Playwright
           userAgent: nil,
           viewport: nil,
           &block)
-      wrap_impl(@impl.launch_browser(acceptDownloads: unwrap_impl(acceptDownloads), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), command: unwrap_impl(command), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), forcedColors: unwrap_impl(forcedColors), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), record_har_content: unwrap_impl(record_har_content), record_har_mode: unwrap_impl(record_har_mode), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_har_url_filter: unwrap_impl(record_har_url_filter), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), serviceWorkers: unwrap_impl(serviceWorkers), strictSelectors: unwrap_impl(strictSelectors), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
+      wrap_impl(@impl.launch_browser(acceptDownloads: unwrap_impl(acceptDownloads), args: unwrap_impl(args), baseURL: unwrap_impl(baseURL), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), command: unwrap_impl(command), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), forcedColors: unwrap_impl(forcedColors), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_content: unwrap_impl(record_har_content), record_har_mode: unwrap_impl(record_har_mode), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_har_url_filter: unwrap_impl(record_har_url_filter), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), reducedMotion: unwrap_impl(reducedMotion), screen: unwrap_impl(screen), serviceWorkers: unwrap_impl(serviceWorkers), strictSelectors: unwrap_impl(strictSelectors), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
     end
 
+    #
     # Performs a long tap on the widget defined by `selector`.
     def long_tap(selector)
       raise NotImplementedError.new('long_tap is not implemented yet.')
     end
 
+    #
     # Device model.
     def model
       wrap_impl(@impl.model)
     end
 
+    #
     # Launches a process in the shell on the device and returns a socket to communicate with the launched process.
     def open(command)
       raise NotImplementedError.new('open is not implemented yet.')
     end
 
+    #
     # Pinches the widget defined by `selector` in the closing direction.
     def pinch_close(selector, percent, speed: nil)
       raise NotImplementedError.new('pinch_close is not implemented yet.')
     end
 
+    #
     # Pinches the widget defined by `selector` in the open direction.
     def pinch_open(selector, percent, speed: nil)
       raise NotImplementedError.new('pinch_open is not implemented yet.')
     end
 
+    #
     # Presses the specific `key` in the widget defined by `selector`.
     def press(selector, key)
       raise NotImplementedError.new('press is not implemented yet.')
     end
 
+    #
     # Copies a file to the device.
     def push(file, path, mode: nil)
       raise NotImplementedError.new('push is not implemented yet.')
     end
 
+    #
     # Returns the buffer with the captured screenshot of the device.
     def screenshot(path: nil)
       wrap_impl(@impl.screenshot(path: unwrap_impl(path)))
     end
 
+    #
     # Scrolls the widget defined by `selector` in  the specified `direction`.
     def scroll(selector, direction, percent, speed: nil)
       raise NotImplementedError.new('scroll is not implemented yet.')
     end
 
+    #
     # Device serial number.
     def serial
       wrap_impl(@impl.serial)
     end
 
+    #
     # This setting will change the default maximum time for all the methods accepting `timeout` option.
     def set_default_timeout(timeout)
       raise NotImplementedError.new('set_default_timeout is not implemented yet.')
     end
     alias_method :default_timeout=, :set_default_timeout
 
+    #
     # Executes a shell command on the device and returns its output.
     def shell(command)
       wrap_impl(@impl.shell(unwrap_impl(command)))
     end
 
+    #
     # Swipes the widget defined by `selector` in  the specified `direction`.
     def swipe(selector, direction, percent, speed: nil)
       raise NotImplementedError.new('swipe is not implemented yet.')
     end
 
+    #
     # Taps on the widget defined by `selector`.
     def tap_point(selector, duration: nil)
       raise NotImplementedError.new('tap_point is not implemented yet.')
     end
 
+    #
     # Waits for the specific `selector` to either appear or disappear, depending on the `state`.
     def wait(selector, state: nil)
       raise NotImplementedError.new('wait is not implemented yet.')
     end
 
-    # Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy
-    # value.
+    #
+    # Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy value.
     def wait_for_event(event, optionsOrPredicate: nil)
       raise NotImplementedError.new('wait_for_event is not implemented yet.')
     end
 
-    # This method waits until `AndroidWebView` matching the `selector` is opened and returns it. If there is already an open
-    # `AndroidWebView` matching the `selector`, returns immediately.
+    #
+    # This method waits until `AndroidWebView` matching the `selector` is opened and returns it. If there is already an open `AndroidWebView` matching the `selector`, returns immediately.
     def web_view(selector)
       raise NotImplementedError.new('web_view is not implemented yet.')
     end
 
+    #
     # Currently open WebViews.
     def web_views
       raise NotImplementedError.new('web_views is not implemented yet.')
     end
 
+    # @nodoc
+    def should_close_connection_on_close!
+      wrap_impl(@impl.should_close_connection_on_close!)
+    end
+
     # @nodoc
     def tap_on(selector, duration: nil, timeout: nil)
       wrap_impl(@impl.tap_on(unwrap_impl(selector), duration: unwrap_impl(duration), timeout: unwrap_impl(timeout)))

data/lib/playwright_api/android_input.rb

@@ -1,26 +1,31 @@
 module Playwright
   class AndroidInput < PlaywrightApi
 
+    #
     # Performs a drag between `from` and `to` points.
     def drag(from, to, steps)
       wrap_impl(@impl.drag(unwrap_impl(from), unwrap_impl(to), unwrap_impl(steps)))
     end
 
+    #
     # Presses the `key`.
     def press(key)
       wrap_impl(@impl.press(unwrap_impl(key)))
     end
 
+    #
     # Swipes following the path defined by `segments`.
     def swipe(from, segments, steps)
       raise NotImplementedError.new('swipe is not implemented yet.')
     end
 
+    #
     # Taps at the specified `point`.
     def tap_point(point)
       wrap_impl(@impl.tap_point(unwrap_impl(point)))
     end
 
+    #
     # Types `text` into currently focused widget.
     def type(text)
       wrap_impl(@impl.type(unwrap_impl(text)))

data/lib/playwright_api/android_socket.rb

@@ -1,13 +1,15 @@
 module Playwright
-  # `AndroidSocket` is a way to communicate with a process launched on the `AndroidDevice`. Use
-  # [`method: AndroidDevice.open`] to open a socket.
+  #
+  # `AndroidSocket` is a way to communicate with a process launched on the `AndroidDevice`. Use [`method: AndroidDevice.open`] to open a socket.
   class AndroidSocket < PlaywrightApi
 
+    #
     # Closes the socket.
     def close
       raise NotImplementedError.new('close is not implemented yet.')
     end
 
+    #
     # Writes some `data` to the socket.
     def write(data)
       raise NotImplementedError.new('write is not implemented yet.')

data/lib/playwright_api/android_web_view.rb

@@ -1,18 +1,21 @@
 module Playwright
-  # `AndroidWebView` represents a WebView open on the `AndroidDevice`. WebView is usually obtained using
-  # [`method: AndroidDevice.webView`].
+  #
+  # `AndroidWebView` represents a WebView open on the `AndroidDevice`. WebView is usually obtained using [`method: AndroidDevice.webView`].
   class AndroidWebView < PlaywrightApi
 
+    #
     # Connects to the WebView and returns a regular Playwright `Page` to interact with.
     def page
       raise NotImplementedError.new('page is not implemented yet.')
     end
 
+    #
     # WebView process PID.
     def pid
       raise NotImplementedError.new('pid is not implemented yet.')
     end
 
+    #
     # WebView package identifier.
     def pkg
       raise NotImplementedError.new('pkg is not implemented yet.')

data/lib/playwright_api/api_request.rb

@@ -1,9 +1,12 @@
 module Playwright
-  # Exposes API that can be used for the Web API testing. This class is used for creating `APIRequestContext` instance which
-  # in turn can be used for sending web requests. An instance of this class can be obtained via
-  # [`property: Playwright.request`]. For more information see `APIRequestContext`.
+  #
+  # Exposes API that can be used for the Web API testing. This class is used for creating
+  # `APIRequestContext` instance which in turn can be used for sending web requests. An instance
+  # of this class can be obtained via [`property: Playwright.request`]. For more information
+  # see `APIRequestContext`.
   class APIRequest < PlaywrightApi
 
+    #
     # Creates new instances of `APIRequestContext`.
     def new_context(
           baseURL: nil,

data/lib/playwright_api/api_request_context.rb

@@ -1,21 +1,23 @@
 module Playwright
+  #
   # This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare
   # environment or the service to your e2e test.
   #
-  # Each Playwright browser context has associated with it `APIRequestContext` instance which shares cookie storage with the
-  # browser context and can be accessed via [`property: BrowserContext.request`] or [`property: Page.request`]. It is also
-  # possible to create a new APIRequestContext instance manually by calling [`method: APIRequest.newContext`].
+  # Each Playwright browser context has associated with it `APIRequestContext` instance which shares cookie storage with
+  # the browser context and can be accessed via [`property: BrowserContext.request`] or [`property: Page.request`].
+  # It is also possible to create a new APIRequestContext instance manually by calling [`method: APIRequest.newContext`].
   #
   # **Cookie management**
   #
   # `APIRequestContext` returned by [`property: BrowserContext.request`] and [`property: Page.request`] shares cookie
-  # storage with the corresponding `BrowserContext`. Each API request will have `Cookie` header populated with the values
-  # from the browser context. If the API response contains `Set-Cookie` header it will automatically update `BrowserContext`
-  # cookies and requests made from the page will pick them up. This means that if you log in using this API, your e2e test
-  # will be logged in and vice versa.
+  # storage with the corresponding `BrowserContext`. Each API request will have `Cookie` header populated with the
+  # values from the browser context. If the API response contains `Set-Cookie` header it will automatically update
+  # `BrowserContext` cookies and requests made from the page will pick them up. This means that if you log in using
+  # this API, your e2e test will be logged in and vice versa.
   #
   # If you want API requests to not interfere with the browser cookies you should create a new `APIRequestContext` by
-  # calling [`method: APIRequest.newContext`]. Such `APIRequestContext` object will have its own isolated cookie storage.
+  # calling [`method: APIRequest.newContext`]. Such `APIRequestContext` object will have its own isolated cookie
+  # storage.
   #
   # ```python sync
   # import os
@@ -65,9 +67,10 @@ module Playwright
   # ```
   class APIRequestContext < PlaywrightApi
 
-    # Sends HTTP(S) [DELETE](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE) request and returns its
-    # response. The method will populate request cookies from the context and update context cookies from the response. The
-    # method will automatically follow redirects.
+    #
+    # Sends HTTP(S) [DELETE](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE) request and returns its response.
+    # The method will populate request cookies from the context and update
+    # context cookies from the response. The method will automatically follow redirects.
     def delete(
           url,
           data: nil,
@@ -82,17 +85,18 @@ module Playwright
       wrap_impl(@impl.delete(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
-    # All responses returned by [`method: APIRequestContext.get`] and similar methods are stored in the memory, so that you
-    # can later call [`method: APIResponse.body`]. This method discards all stored responses, and makes
-    # [`method: APIResponse.body`] throw "Response disposed" error.
+    #
+    # All responses returned by [`method: APIRequestContext.get`] and similar methods are stored in the memory, so that you can later call [`method: APIResponse.body`]. This method
+    # discards all stored responses, and makes [`method: APIResponse.body`] throw "Response disposed" error.
     def dispose
       wrap_impl(@impl.dispose)
     end
 
+    #
     # Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and update
-    # context cookies from the response. The method will automatically follow redirects.
+    # context cookies from the response. The method will automatically follow redirects. JSON objects can be passed directly to the request.
     #
-    # JSON objects can be passed directly to the request:
+    # **Usage**
     #
     # ```python
     # data = {
@@ -102,8 +106,7 @@ module Playwright
     # api_request_context.fetch("https://example.com/api/createBook", method="post", data=data)
     # ```
     #
-    # The common way to send file(s) in the body of a request is to encode it as form fields with `multipart/form-data`
-    # encoding. You can achieve that with Playwright API like this:
+    # The common way to send file(s) in the body of a request is to encode it as form fields with `multipart/form-data` encoding. You can achieve that with Playwright API like this:
     #
     # ```python
     # api_request_context.fetch(
@@ -132,9 +135,12 @@ module Playwright
       wrap_impl(@impl.fetch(unwrap_impl(urlOrRequest), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), method: unwrap_impl(method), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
-    # Sends HTTP(S) [GET](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET) request and returns its response. The
-    # method will populate request cookies from the context and update context cookies from the response. The method will
-    # automatically follow redirects.
+    #
+    # Sends HTTP(S) [GET](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET) request and returns its response.
+    # The method will populate request cookies from the context and update
+    # context cookies from the response. The method will automatically follow redirects.
+    #
+    # **Usage**
     #
     # Request parameters can be configured with `params` option, they will be serialized into the URL search parameters:
     #
@@ -159,9 +165,10 @@ module Playwright
       wrap_impl(@impl.get(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # Sends HTTP(S) [HEAD](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD) request and returns its response.
-    # The method will populate request cookies from the context and update context cookies from the response. The method will
-    # automatically follow redirects.
+    # The method will populate request cookies from the context and update
+    # context cookies from the response. The method will automatically follow redirects.
     def head(
           url,
           data: nil,
@@ -176,9 +183,10 @@ module Playwright
       wrap_impl(@impl.head(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # Sends HTTP(S) [PATCH](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH) request and returns its response.
-    # The method will populate request cookies from the context and update context cookies from the response. The method will
-    # automatically follow redirects.
+    # The method will populate request cookies from the context and update
+    # context cookies from the response. The method will automatically follow redirects.
     def patch(
           url,
           data: nil,
@@ -193,9 +201,12 @@ module Playwright
       wrap_impl(@impl.patch(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
+    #
     # Sends HTTP(S) [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) request and returns its response.
-    # The method will populate request cookies from the context and update context cookies from the response. The method will
-    # automatically follow redirects.
+    # The method will populate request cookies from the context and update
+    # context cookies from the response. The method will automatically follow redirects.
+    #
+    # **Usage**
     #
     # JSON objects can be passed directly to the request:
     #
@@ -207,8 +218,7 @@ module Playwright
     # api_request_context.post("https://example.com/api/createBook", data=data)
     # ```
     #
-    # To send form data to the server use `form` option. Its value will be encoded into the request body with
-    # `application/x-www-form-urlencoded` encoding (see below how to use `multipart/form-data` form encoding to send files):
+    # To send form data to the server use `form` option. Its value will be encoded into the request body with `application/x-www-form-urlencoded` encoding (see below how to use `multipart/form-data` form encoding to send files):
     #
     # ```python
     # formData = {
@@ -218,8 +228,7 @@ module Playwright
     # api_request_context.post("https://example.com/api/findBook", form=formData)
     # ```
     #
-    # The common way to send file(s) in the body of a request is to upload them as form fields with `multipart/form-data`
-    # encoding. You can achieve that with Playwright API like this:
+    # The common way to send file(s) in the body of a request is to upload them as form fields with `multipart/form-data` encoding. You can achieve that with Playwright API like this:
     #
     # ```python
     # api_request_context.post(
@@ -246,9 +255,10 @@ module Playwright
       wrap_impl(@impl.post(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
-    # Sends HTTP(S) [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) request and returns its response. The
-    # method will populate request cookies from the context and update context cookies from the response. The method will
-    # automatically follow redirects.
+    #
+    # Sends HTTP(S) [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) request and returns its response.
+    # The method will populate request cookies from the context and update
+    # context cookies from the response. The method will automatically follow redirects.
     def put(
           url,
           data: nil,
@@ -263,8 +273,8 @@ module Playwright
       wrap_impl(@impl.put(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
-    # Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to
-    # the constructor.
+    #
+    # Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to the constructor.
     def storage_state(path: nil)
       raise NotImplementedError.new('storage_state is not implemented yet.')
     end

data/lib/playwright_api/api_response.rb

@@ -1,4 +1,5 @@
 module Playwright
+  #
   # `APIResponse` class represents responses returned by [`method: APIRequestContext.get`] and similar methods.
   #
   # ```python sync
@@ -15,27 +16,32 @@ module Playwright
   # ```
   class APIResponse < PlaywrightApi
 
+    #
     # Returns the buffer with response body.
     def body
       wrap_impl(@impl.body)
     end
 
+    #
     # Disposes the body of this response. If not called then the body will stay in memory until the context closes.
     def dispose
       wrap_impl(@impl.dispose)
     end
 
+    #
     # An object with all the response HTTP headers associated with this response.
     def headers
       wrap_impl(@impl.headers)
     end
 
-    # An array with all the request HTTP headers associated with this response. Header names are not lower-cased. Headers with
-    # multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+    #
+    # An array with all the request HTTP headers associated with this response. Header names are not lower-cased.
+    # Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
     def headers_array
       wrap_impl(@impl.headers_array)
     end
 
+    #
     # Returns the JSON representation of response body.
     #
     # This method will throw if the response body is not parsable via `JSON.parse`.
@@ -43,26 +49,31 @@ module Playwright
       wrap_impl(@impl.json)
     end
 
+    #
     # Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
     def ok
       wrap_impl(@impl.ok)
     end
 
+    #
     # Contains the status code of the response (e.g., 200 for a success).
     def status
       wrap_impl(@impl.status)
     end
 
+    #
     # Contains the status text of the response (e.g. usually an "OK" for a success).
     def status_text
       wrap_impl(@impl.status_text)
     end
 
+    #
     # Returns the text representation of response body.
     def text
       wrap_impl(@impl.text)
     end
 
+    #
     # Contains the URL of the response.
     def url
       wrap_impl(@impl.url)