Skip to content

Conversation

selenium-ci
Copy link
Member

@selenium-ci selenium-ci commented Oct 17, 2025

User description

This PR updates the API documentation for version 4.37.0-all.


PR Type

Documentation


Description

  • Auto-generated API documentation update for Selenium .NET bindings version 4.37.0

  • Updated DevTools V141 documentation with new adapter classes and domain types (Browser, Animation, BluetoothEmulation, Audits, Accessibility, CSS, DOM, and others)

  • Added new BiDi classes and updated existing ones with refined type signatures and event handling

  • Removed outdated DevTools V138 documentation files

  • Updated method return types in BrowsingContextModule from generic EmptyResult to specific result types

  • Added new event overloads for download handling with DownloadEndEventArgs and DownloadWillBeginEventArgs

  • Updated source code line number references throughout documentation due to code changes

  • Added JSON converter attributes to enum definitions for proper serialization


Diagram Walkthrough

flowchart LR
  A["Selenium 4.37.0<br/>Release"] -->|"Auto-generated<br/>Documentation"| B["DevTools V141<br/>Documentation"]
  A -->|"BiDi Updates"| C["BrowsingContext &<br/>Network Modules"]
  B --> D["New Adapters &<br/>Domain Types"]
  C --> E["Updated Method<br/>Signatures & Events"]
  F["DevTools V138<br/>Documentation"] -->|"Removed"| G["Deprecated Files"]
Loading

File Walkthrough

Relevant files
Documentation
8 files
OpenQA.Selenium.BiDi.BrowsingContext.BrowsingContextModule.html
API documentation updates for BrowsingContextModule with new result
types

docs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.BrowsingContext.BrowsingContextModule.html

  • Removed the Constructors section documenting the
    BrowsingContextModule(Broker) constructor
  • Updated return types for multiple async methods from EmptyResult to
    specific result types (ActivateResult, CloseResult, CreateResult,
    HandleUserPromptResult, ReloadResult, SetViewportResult)
  • Added two new OnDownloadEndAsync method overloads with
    DownloadEndEventArgs parameter
  • Changed OnDownloadWillBeginAsync method signatures to use
    DownloadWillBeginEventArgs instead of NavigationInfo
  • Updated source code line number references throughout the
    documentation due to constructor removal
+133/-92
OpenQA.Selenium.DevTools.V141.DOM.Node.html
New DevTools V141 DOM Node class API documentation             

docs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V141.DOM.Node.html

  • New file added with complete HTML documentation for the Node class in
    DevTools V141 DOM namespace
  • Documents 30+ properties including NodeId, NodeName, NodeType,
    Attributes, Children, and various optional properties
  • Includes proper JSON serialization attributes and inheritance
    information
  • Provides links to source code and Microsoft documentation references
+1260/-0
OpenQA.Selenium.BiDi.Browser.UserContextInfo.html
UserContextInfo record modifier and inheritance updates   

docs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.Browser.UserContextInfo.html

  • Changed UserContextInfo from sealed record to record (removed sealed
    modifier)
  • Added CreateUserContextResult as a derived type in the documentation
  • Added object.MemberwiseClone() to inherited members list
+10/-1   
OpenQA.Selenium.DevTools.V141.Browser.BrowserAdapter.html
New DevTools V141 Browser adapter API documentation           

docs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V141.Browser.BrowserAdapter.html

  • Added new HTML documentation file for BrowserAdapter class in DevTools
    V141 Browser domain
  • Documents adapter class that simplifies Browser domain command
    interface with 1186 lines of content
  • Includes constructor, properties, methods for browser operations
    (permissions, downloads, window management), and events
  • Provides API reference with method signatures, parameters, return
    types, and exception documentation
+1186/-0
OpenQA.Selenium.DevTools.V141.Animation.AnimationAdapter.html
New DevTools V141 Animation adapter API documentation       

docs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V141.Animation.AnimationAdapter.html

  • Added new HTML documentation file for AnimationAdapter class in
    DevTools V141 Animation domain
  • Documents adapter class that simplifies Animation domain command
    interface with 818 lines of content
  • Includes constructor, properties, methods for animation control
    (enable, disable, playback, timing), and events
  • Provides complete API reference with method signatures, parameters,
    return types, and event documentation
+818/-0 
OpenQA.Selenium.DevTools.V141.BluetoothEmulation.BluetoothEmulationAdapter.html
New BluetoothEmulation adapter API documentation                 

docs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V141.BluetoothEmulation.BluetoothEmulationAdapter.html

  • Added new HTML documentation file for BluetoothEmulationAdapter class
    in DevTools V141
  • Documents adapter for BluetoothEmulation domain with methods for
    service, characteristic, and descriptor management
  • Includes constructor, properties, methods for enable/disable/simulate
    operations, and event handlers
  • Provides API reference with links to source code and parameter
    documentation
+1002/-0
OpenQA.Selenium.DevTools.V141.Audits.InspectorIssueDetails.html
New InspectorIssueDetails API documentation                           

docs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V141.Audits.InspectorIssueDetails.html

  • Added new HTML documentation file for InspectorIssueDetails class in
    DevTools V141 Audits
  • Documents sealed class with 25+ properties for various issue detail
    types (cookies, CORS, CSP, etc.)
  • Includes comprehensive property documentation with JSON serialization
    attributes
  • Provides complete API reference for inspector issue categorization
+1062/-0
OpenQA.Selenium.BiDi.BrowsingContext.BoxClipRectangle.html
Update BoxClipRectangle source code line references           

docs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.BrowsingContext.BoxClipRectangle.html

  • Updated source code line number references from line 56 to line 58 in
    multiple locations
  • Changed GitHub source links for class definition, constructor, and all
    four properties
  • Updated edit page link to reflect new source location
+7/-7     
Enhancement
1 files
OpenQA.Selenium.BiDi.BrowsingContext.ContextType.html
Add JSON converter attribute to ContextType enum                 

docs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.BrowsingContext.ContextType.html

  • Updated line number reference in source code link from line 38 to line
    40
  • Added [JsonConverter(typeof(CamelCaseEnumConverter))] attribute to
    ContextType enum definition
  • Updated edit page link to reflect new source location
+4/-3     
Additional files
101 files
index.json [link]   
manifest.json [link]   
OpenQA.Selenium.BiDi.BiDi.html +44/-13 
OpenQA.Selenium.BiDi.Browser.BrowserModule.html +116/-41
OpenQA.Selenium.BiDi.Browser.ClientWindow.html +4/-3     
OpenQA.Selenium.BiDi.Browser.ClientWindowInfo.html +10/-10 
OpenQA.Selenium.BiDi.Browser.ClientWindowState.html +4/-3     
OpenQA.Selenium.BiDi.Browser.CloseResult.html +181/-0 
OpenQA.Selenium.BiDi.Browser.CreateUserContextResult.html +221/-0 
OpenQA.Selenium.BiDi.Browser.GetClientWindowsOptions.html +2/-2     
OpenQA.Selenium.BiDi.Browser.GetClientWindowsResult.html +19/-90 
OpenQA.Selenium.BiDi.Browser.GetUserContextsOptions.html +2/-2     
OpenQA.Selenium.BiDi.Browser.GetUserContextsResult.html +15/-86 
OpenQA.Selenium.BiDi.Browser.RemoveUserContextResult.html +181/-0 
OpenQA.Selenium.BiDi.Browser.SetDownloadBehaviorOptions.html +212/-0 
OpenQA.Selenium.BiDi.Browser.SetDownloadBehaviorResult.html +181/-0 
OpenQA.Selenium.BiDi.Browser.html +20/-0   
OpenQA.Selenium.BiDi.BrowsingContext.AccessibilityLocator.html +4/-4     
OpenQA.Selenium.BiDi.BrowsingContext.AccessibilityValue.html +4/-4     
OpenQA.Selenium.BiDi.BrowsingContext.ActivateResult.html +181/-0 
OpenQA.Selenium.BiDi.BrowsingContext.BrowsingContext.html +102/-26
OpenQA.Selenium.BiDi.BrowsingContext.BrowsingContextGetTreeOptions.html +3/-3     
OpenQA.Selenium.BiDi.BrowsingContext.BrowsingContextInputModule.html +12/-12 
OpenQA.Selenium.BiDi.BrowsingContext.BrowsingContextNetworkModule.html +19/-19 
OpenQA.Selenium.BiDi.BrowsingContext.BrowsingContextScriptModule.html +13/-13 
OpenQA.Selenium.BiDi.BrowsingContext.CaptureScreenshotOptions.html +5/-5     
OpenQA.Selenium.BiDi.BrowsingContext.CaptureScreenshotResult.html +6/-6     
OpenQA.Selenium.BiDi.BrowsingContext.ClipRectangle.html +2/-2     
OpenQA.Selenium.BiDi.BrowsingContext.CloseResult.html +181/-0 
OpenQA.Selenium.BiDi.BrowsingContext.ContextLocator.html +4/-4     
OpenQA.Selenium.BiDi.BrowsingContext.ContextValue.html +4/-4     
OpenQA.Selenium.BiDi.BrowsingContext.CreateOptions.html +5/-5     
OpenQA.Selenium.BiDi.BrowsingContext.CreateResult.html +4/-4     
OpenQA.Selenium.BiDi.BrowsingContext.CssLocator.html +4/-4     
OpenQA.Selenium.BiDi.BrowsingContext.DownloadCanceledEventArgs.html +332/-0 
OpenQA.Selenium.BiDi.BrowsingContext.DownloadCompleteEventArgs.html +365/-0 
OpenQA.Selenium.BiDi.BrowsingContext.DownloadEndEventArgs.html +237/-0 
OpenQA.Selenium.BiDi.BrowsingContext.DownloadWillBeginEventArgs.html +363/-0 
OpenQA.Selenium.BiDi.BrowsingContext.ElementClipRectangle.html +4/-4     
OpenQA.Selenium.BiDi.BrowsingContext.GetTreeOptions.html +5/-5     
OpenQA.Selenium.BiDi.BrowsingContext.GetTreeResult.html +19/-90 
OpenQA.Selenium.BiDi.BrowsingContext.HandleUserPromptResult.html +181/-0 
OpenQA.Selenium.BiDi.BrowsingContext.ImageFormat.html +5/-5     
OpenQA.Selenium.BiDi.BrowsingContext.InnerTextLocator.html +7/-7     
OpenQA.Selenium.BiDi.BrowsingContext.InterceptAuthOptions.html +2/-2     
OpenQA.Selenium.BiDi.BrowsingContext.InterceptRequestOptions.html +2/-2     
OpenQA.Selenium.BiDi.BrowsingContext.InterceptResponseOptions.html +2/-2     
OpenQA.Selenium.BiDi.BrowsingContext.LocateNodesOptions.html +5/-5     
OpenQA.Selenium.BiDi.BrowsingContext.LocateNodesResult.html +15/-86 
OpenQA.Selenium.BiDi.BrowsingContext.Locator.html +2/-2     
OpenQA.Selenium.BiDi.BrowsingContext.MatchType.html +4/-3     
OpenQA.Selenium.BiDi.BrowsingContext.NavigateOptions.html +3/-3     
OpenQA.Selenium.BiDi.BrowsingContext.NavigateResult.html +15/-6   
OpenQA.Selenium.BiDi.BrowsingContext.Navigation.html +6/-5     
OpenQA.Selenium.BiDi.BrowsingContext.PrintMargin.html +6/-6     
OpenQA.Selenium.BiDi.BrowsingContext.PrintOptions.html +9/-9     
OpenQA.Selenium.BiDi.BrowsingContext.PrintOrientation.html +4/-3     
OpenQA.Selenium.BiDi.BrowsingContext.PrintPage.html +4/-4     
OpenQA.Selenium.BiDi.BrowsingContext.PrintPageRange.html +8/-7     
OpenQA.Selenium.BiDi.BrowsingContext.PrintResult.html +5/-5     
OpenQA.Selenium.BiDi.BrowsingContext.ReadinessState.html +4/-3     
OpenQA.Selenium.BiDi.BrowsingContext.ReloadResult.html +226/-0 
OpenQA.Selenium.BiDi.BrowsingContext.ScreenshotOrigin.html +4/-3     
OpenQA.Selenium.BiDi.BrowsingContext.SetViewportResult.html +181/-0 
OpenQA.Selenium.BiDi.BrowsingContext.UserPromptOpenedEventArgs.html +7/-7     
OpenQA.Selenium.BiDi.BrowsingContext.UserPromptType.html +4/-3     
OpenQA.Selenium.BiDi.BrowsingContext.XPathLocator.html +4/-4     
OpenQA.Selenium.BiDi.BrowsingContext.html +36/-0   
OpenQA.Selenium.BiDi.BrowsingContextEventArgs.html +2/-0     
OpenQA.Selenium.BiDi.Communication.Broker.html +25/-17 
OpenQA.Selenium.BiDi.Communication.Command.html +5/-39   
OpenQA.Selenium.BiDi.Communication.CommandOptions.html +10/-0   
OpenQA.Selenium.BiDi.Communication.EmptyResult.html +35/-3   
OpenQA.Selenium.BiDi.Communication.EventHandler.html +7/-40   
OpenQA.Selenium.BiDi.Communication.Json.Converters.CamelCaseEnumConverter-1.html +223/-0 
OpenQA.Selenium.BiDi.Communication.Json.Converters.KebabCaseEnumConverter-1.html +223/-0 
OpenQA.Selenium.BiDi.Communication.Json.Converters.html +130/-0 
OpenQA.Selenium.BiDi.Communication.html +7/-0     
OpenQA.Selenium.BiDi.Emulation.EmulationModule.html +518/-0 
OpenQA.Selenium.BiDi.Emulation.ForcedColorsModeTheme.html +152/-0 
OpenQA.Selenium.BiDi.Emulation.ScreenOrientation.html +282/-0 
OpenQA.Selenium.BiDi.Emulation.ScreenOrientationNatural.html +152/-0 
OpenQA.Selenium.BiDi.Emulation.ScreenOrientationType.html +156/-0 
OpenQA.Selenium.BiDi.Emulation.SetForcedColorsModeThemeOverrideOptions.html +243/-0 
OpenQA.Selenium.BiDi.Emulation.SetForcedColorsModeThemeOverrideResult.html +181/-0 
OpenQA.Selenium.BiDi.Emulation.SetGeolocationCoordinatesOverrideOptions.html +343/-0 
OpenQA.Selenium.BiDi.Emulation.SetGeolocationOverrideOptions.html +253/-0 
OpenQA.Selenium.BiDi.Emulation.SetGeolocationOverrideResult.html +181/-0 
OpenQA.Selenium.BiDi.Emulation.SetGeolocationPositionErrorOverrideOptions.html +184/-0 
OpenQA.Selenium.BiDi.Emulation.SetLocaleOverrideOptions.html +243/-0 
OpenQA.Selenium.BiDi.Emulation.SetLocaleOverrideResult.html +181/-0 
OpenQA.Selenium.BiDi.Emulation.SetScreenOrientationOverrideOptions.html +243/-0 
OpenQA.Selenium.BiDi.Emulation.SetScreenOrientationOverrideResult.html +181/-0 
OpenQA.Selenium.BiDi.Emulation.SetScriptingEnabledOptions.html +243/-0 
OpenQA.Selenium.BiDi.Emulation.SetScriptingEnabledResult.html +181/-0 
OpenQA.Selenium.BiDi.Emulation.SetTimezoneOverrideOptions.html +243/-0 
OpenQA.Selenium.BiDi.Emulation.SetTimezoneOverrideResult.html +181/-0 
OpenQA.Selenium.BiDi.Emulation.SetUserAgentOverrideOptions.html +243/-0 
OpenQA.Selenium.BiDi.Emulation.SetUserAgentOverrideResult.html +181/-0 
OpenQA.Selenium.BiDi.Emulation.html +209/-0 
Additional files not shown

@selenium-ci selenium-ci added the B-docs API Docs; see other repo for website documentation label Oct 17, 2025
@selenium-ci selenium-ci merged commit 832709b into gh-pages Oct 17, 2025
@selenium-ci selenium-ci deleted the api-docs-4.37.0 branch October 17, 2025 21:40
Copy link
Contributor

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢
No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🎫 No ticket provided
- [ ] Create ticket/issue <!-- /create_ticket --create_ticket=true -->

</details></td></tr>
Codebase Duplication Compliance
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
No custom compliance provided

Follow the guide to enable custom compliance check.

Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

Copy link
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Handle potential localStorage access errors

Wrap the theme-setting script in a try...catch block to handle potential errors
if localStorage is disabled, with a fallback to the OS color scheme.

docs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V141.CSS.CSSAdapter.html [35-38]

 <script>
-  const theme = localStorage.getItem('theme') || 'auto'
-  document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
+  try {
+    const theme = localStorage.getItem('theme') || 'auto'
+    document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
+  } catch (e) {
+    // Fallback to OS preference if localStorage is not available
+    const osTheme = window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light';
+    document.documentElement.setAttribute('data-bs-theme', osTheme);
+  }
 </script>
  • Apply / Chat
Suggestion importance[1-10]: 6

__

Why: The suggestion correctly identifies a potential runtime error if localStorage is disabled and provides a robust solution using a try...catch block with a sensible fallback, improving the user experience for the documentation.

Low
  • More

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

B-docs API Docs; see other repo for website documentation Review effort 2/5

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant