diff --git a/rb/lib/selenium/webdriver/bidi/browser.rb b/rb/lib/selenium/webdriver/bidi/browser.rb index f6d9e9202fb5c..d69bb269d37d7 100644 --- a/rb/lib/selenium/webdriver/bidi/browser.rb +++ b/rb/lib/selenium/webdriver/bidi/browser.rb @@ -20,6 +20,13 @@ module Selenium module WebDriver class BiDi + # + # BiDi Implementation of the Browser Module + # Continue to use functionality from existing `driver.manager.window` method + # + # @api private + # + class Browser Window = Struct.new(:handle, :active, :height, :width, :x, :y, :state) do def active? diff --git a/rb/lib/selenium/webdriver/bidi/browsing_context.rb b/rb/lib/selenium/webdriver/bidi/browsing_context.rb index 32816740ffe0f..89a03517d643b 100644 --- a/rb/lib/selenium/webdriver/bidi/browsing_context.rb +++ b/rb/lib/selenium/webdriver/bidi/browsing_context.rb @@ -20,7 +20,8 @@ module Selenium module WebDriver class BiDi - # Implements the browsingContext Module of the WebDriver-BiDi specification + # Implements the BrowsingContext Module of the WebDriver-BiDi specification + # Continue to use functionality from existing `driver.navigate` method # # @api private # diff --git a/rb/lib/selenium/webdriver/bidi/log_handler.rb b/rb/lib/selenium/webdriver/bidi/log_handler.rb index 29b3d4dcab0d9..27022933c1edd 100644 --- a/rb/lib/selenium/webdriver/bidi/log_handler.rb +++ b/rb/lib/selenium/webdriver/bidi/log_handler.rb @@ -20,6 +20,11 @@ module Selenium module WebDriver class BiDi + # Implements the Log of the WebDriver-BiDi specification + # This functionality should be accessed through `driver.script` method + # + # @api private + # class LogHandler ConsoleLogEntry = BiDi::Struct.new(:level, :text, :timestamp, :stack_trace, :type, :source, :method, :args) JavaScriptLogEntry = BiDi::Struct.new(:level, :text, :timestamp, :stack_trace, :type, :source) diff --git a/rb/lib/selenium/webdriver/bidi/network.rb b/rb/lib/selenium/webdriver/bidi/network.rb index 0042ac8578d1d..62bacd9d8218c 100644 --- a/rb/lib/selenium/webdriver/bidi/network.rb +++ b/rb/lib/selenium/webdriver/bidi/network.rb @@ -21,6 +21,12 @@ module Selenium module WebDriver class BiDi + # Implements the Navigation Module of the WebDriver-BiDi specification + # Continue to use functionality from existing `driver.navigate` method + # + # @api private + # + class Network EVENTS = { before_request: 'network.beforeRequestSent', diff --git a/rb/lib/selenium/webdriver/bidi/network/cookies.rb b/rb/lib/selenium/webdriver/bidi/network/cookies.rb index 027a658a59f77..da7da344a589e 100644 --- a/rb/lib/selenium/webdriver/bidi/network/cookies.rb +++ b/rb/lib/selenium/webdriver/bidi/network/cookies.rb @@ -20,6 +20,10 @@ module Selenium module WebDriver class BiDi + # + # @api private + # + class Cookies < Hash def as_json map do |name, val| diff --git a/rb/lib/selenium/webdriver/bidi/network/credentials.rb b/rb/lib/selenium/webdriver/bidi/network/credentials.rb index a0e3db7905410..18fd1546a0f8d 100644 --- a/rb/lib/selenium/webdriver/bidi/network/credentials.rb +++ b/rb/lib/selenium/webdriver/bidi/network/credentials.rb @@ -20,6 +20,10 @@ module Selenium module WebDriver class BiDi + # + # @api private + # + class Credentials attr_accessor :username, :password diff --git a/rb/lib/selenium/webdriver/bidi/network/headers.rb b/rb/lib/selenium/webdriver/bidi/network/headers.rb index 44983f6eb58fb..8bb4df2ecf9ae 100644 --- a/rb/lib/selenium/webdriver/bidi/network/headers.rb +++ b/rb/lib/selenium/webdriver/bidi/network/headers.rb @@ -20,6 +20,10 @@ module Selenium module WebDriver class BiDi + # + # @api private + # + class Headers < Hash def as_json map do |name, val| diff --git a/rb/lib/selenium/webdriver/bidi/network/intercepted_auth.rb b/rb/lib/selenium/webdriver/bidi/network/intercepted_auth.rb index 71c5d7bcac785..1e0dab72d8178 100644 --- a/rb/lib/selenium/webdriver/bidi/network/intercepted_auth.rb +++ b/rb/lib/selenium/webdriver/bidi/network/intercepted_auth.rb @@ -20,6 +20,10 @@ module Selenium module WebDriver class BiDi + # + # @api private + # + class InterceptedAuth < InterceptedItem def authenticate(username, password) network.continue_with_auth(id, username, password) diff --git a/rb/lib/selenium/webdriver/bidi/network/intercepted_item.rb b/rb/lib/selenium/webdriver/bidi/network/intercepted_item.rb index 1f7445ebbe78b..09c0859060b25 100644 --- a/rb/lib/selenium/webdriver/bidi/network/intercepted_item.rb +++ b/rb/lib/selenium/webdriver/bidi/network/intercepted_item.rb @@ -20,6 +20,10 @@ module Selenium module WebDriver class BiDi + # + # @api private + # + class InterceptedItem attr_reader :network, :request diff --git a/rb/lib/selenium/webdriver/bidi/network/intercepted_request.rb b/rb/lib/selenium/webdriver/bidi/network/intercepted_request.rb index f87c99d620252..85e4f4df12aea 100644 --- a/rb/lib/selenium/webdriver/bidi/network/intercepted_request.rb +++ b/rb/lib/selenium/webdriver/bidi/network/intercepted_request.rb @@ -23,6 +23,10 @@ module Selenium module WebDriver class BiDi + # + # @api private + # + class InterceptedRequest < InterceptedItem attr_accessor :method, :url attr_reader :body diff --git a/rb/lib/selenium/webdriver/bidi/network/intercepted_response.rb b/rb/lib/selenium/webdriver/bidi/network/intercepted_response.rb index 433c9edcadb23..919618d37fd0d 100644 --- a/rb/lib/selenium/webdriver/bidi/network/intercepted_response.rb +++ b/rb/lib/selenium/webdriver/bidi/network/intercepted_response.rb @@ -24,6 +24,10 @@ module Selenium module WebDriver class BiDi + # + # @api private + # + class InterceptedResponse < InterceptedItem attr_accessor :reason, :status attr_reader :body diff --git a/rb/lib/selenium/webdriver/bidi/network/url_pattern.rb b/rb/lib/selenium/webdriver/bidi/network/url_pattern.rb index 659b4be4a82b5..f711e799e1e4d 100644 --- a/rb/lib/selenium/webdriver/bidi/network/url_pattern.rb +++ b/rb/lib/selenium/webdriver/bidi/network/url_pattern.rb @@ -22,6 +22,10 @@ module Selenium module WebDriver class BiDi + # + # @api private + # + module UrlPattern module_function diff --git a/rb/lib/selenium/webdriver/bidi/session.rb b/rb/lib/selenium/webdriver/bidi/session.rb index d3ae6792c46d9..4c1f0486d2251 100644 --- a/rb/lib/selenium/webdriver/bidi/session.rb +++ b/rb/lib/selenium/webdriver/bidi/session.rb @@ -20,6 +20,10 @@ module Selenium module WebDriver class BiDi + # Implements the Session Module of the WebDriver-BiDi specification + # + # @api private + # class Session Status = Struct.new(:ready, :message)