You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updates base class derived types references to reflect version progression (V140, V141, V142)
Corrects source code line number references in documentation files
Diagram Walkthrough
flowchart LR
A["V139 DevTools<br/>Documentation"] -->|Remove| B["Documentation<br/>Update"]
C["V142 DevTools<br/>Domains"] -->|Add| B
D["BiDi Classes<br/>Updates"] -->|Update| B
B -->|Generate| E["4.38.0-all<br/>API Docs"]
Avoid committing auto-generated documentation files to the source repository. Instead, generate and publish them via a CI/CD pipeline to keep the repository clean and focused on source code.
<!DOCTYPE html><html><head><metacharset="utf-8"><title>Class DOMAdapter </title><metaname="viewport" content="width=device-width, initial-scale=1.0"><metaname="title" content="Class DOMAdapter "><metaname="description" content="Represents an adapter for the DOM domain to simplify the command interface."><linkrel="icon" href="../images/favicon.ico">
... (clipped 3060 lines)
<!DOCTYPE html><html><head><metacharset="utf-8"><title>Class EmulationAdapter </title><metaname="viewport" content="width=device-width, initial-scale=1.0"><metaname="title" content="Class EmulationAdapter "><metaname="description" content="Represents an adapter for the Emulation domain to simplify the command interface."><linkrel="icon" href="../images/favicon.ico">
... (clipped 2263 lines)
Solution Walkthrough:
Before:
# PR commits numerous generated HTML files to the repository.
# Example file structure in the commit:
#
# /docs
# └── /api
# └── /dotnet
# └── /webdriver
# ├── OpenQA.Selenium.DevTools.V142.DOM.DOMAdapter.html
# ├── OpenQA.Selenium.DevTools.V142.Emulation.EmulationAdapter.html
# ├── OpenQA.Selenium.DevTools.V142.CSS.CSSAdapter.html
# └── ... (hundreds of other generated files)
After:
# Generated files are not committed. Instead, they are built and deployed by a CI/CD pipeline.
# .gitignore
# Ignore generated documentation files
docs/api/
# ci_pipeline.yml (conceptual)
jobs:
release:
steps:
- name: Checkout code
...
- name: Generate documentation
run: build-docs-script
- name: Publish documentation to a hosting service (e.g., GitHub Pages)
...
Suggestion importance[1-10]: 9
__
Why: This is a critical repository management and process suggestion that correctly identifies the issue of committing large, auto-generated files, which bloats the repository and complicates reviews.
High
Security
Implement Content Security Policy header
Implement a Content Security Policy (CSP) by adding a meta tag. Use a nonce for the inline script and Subresource Integrity (SRI) for the external script to mitigate Cross-Site Scripting (XSS) risks.
Why: The suggestion correctly identifies the lack of a Content Security Policy (CSP), which is a critical security measure against XSS attacks, and provides a valid implementation pattern.
Medium
General
Add listener for system theme changes
Refactor the theme-setting script and add an event listener to prefers-color-scheme to dynamically update the theme when the system's color scheme changes.
Why: The suggestion correctly identifies that the theme does not update on system-level changes and provides a valid code improvement to add this functionality, enhancing user experience.
Low
Learned best practice
Align nullability in docs
Ensure method signatures and summaries clearly reflect optional parameters and nullable return types consistently across all similar methods in this adapter.
[To ensure code accuracy, apply this suggestion manually]
Suggestion importance[1-10]: 6
__
Why:
Relevant best practice - Keep API and documentation accurate and consistent by aligning parameter nullability/optionality across docs and interfaces.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
This PR updates the API documentation for version 4.38.0-all.
PR Type
Documentation
Description
Auto-generated API documentation update for Selenium 4.38.0-all
Adds comprehensive HTML documentation for DevTools V142 domain adapters and related classes
Includes new documentation for multiple DevTools domains: Debugger, Browser, Animation, DOM, CSS, Emulation, Accessibility, Audits, and many others
Updates BiDi documentation with parameter changes to
UserPromptClosedEventArgsclassRemoves outdated V139 DevTools documentation files
Updates base class derived types references to reflect version progression (V140, V141, V142)
Corrects source code line number references in documentation files
Diagram Walkthrough
File Walkthrough
8 files
OpenQA.Selenium.DevTools.V142.Debugger.DebuggerAdapter.html
New DevTools V142 DebuggerAdapter API documentationdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V142.Debugger.DebuggerAdapter.html
DebuggerAdapterclass in DevTools V142
methods, and events
SetBreakpoint,StepInto,Resume, etc.BreakpointResolved,Paused,Resumed,and
ScriptParsedOpenQA.Selenium.BiDi.BrowsingContext.UserPromptClosedEventArgs.html
Updated UserPromptClosedEventArgs with UserText parameterdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.BrowsingContext.UserPromptClosedEventArgs.html
UserTextparameter asstring?UserTextproperty from[JsonInclude]getter-only toget;init;accessorto line 22)
OpenQA.Selenium.DevTools.V142.DevToolsSessionDomains.html
DevTools V142 Session Domains API documentationdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V142.DevToolsSessionDomains.html
DevToolsSessionDomainsclass in DevTools V142
IDevToolsSessionAudits, Browser, CSS, DOM, Network, etc.)
PopulateCommandResponseTypeMap()OpenQA.Selenium.DevTools.V142.Debugger.ScriptFailedToParseEventArgs.html
Debugger ScriptFailedToParseEventArgs event documentationdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V142.Debugger.ScriptFailedToParseEventArgs.html
ScriptFailedToParseEventArgsevent argsclass in Debugger domain
ScriptId,Url,StartLine,EndLine,Hash,BuildId,ExecutionContextIdSourceMapURL,StackTrace,ScriptLanguage,EmbedderName,CodeOffsetOpenQA.Selenium.DevTools.DevToolsSessionDomains.html
Updated base class derived types for V142docs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.DevToolsSessionDomains.html
DevToolsSessionDomains(V140, V141, V142)
OpenQA.Selenium.DevTools.V142.Browser.BrowserAdapter.html
Add DevTools V142 Browser adapter API documentationdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V142.Browser.BrowserAdapter.html
BrowserAdapterclass in DevTools V142 Browser domain
Browser domain operations
crash, permissions, downloads, etc.), and events
signatures, and parameter descriptions
OpenQA.Selenium.DevTools.V142.Animation.AnimationAdapter.html
Add DevTools V142 Animation adapter API documentationdocs/api/dotnet/webdriver/OpenQA.Selenium.DevTools.V142.Animation.AnimationAdapter.html
AnimationAdapterclass in DevTools V142 Animation domain
Animation domain operations
(enable, disable, seek, timing, etc.), and events
signatures, and parameter descriptions
OpenQA.Selenium.BiDi.Script.Mode.html
Update BiDi Script Mode enum documentation line referencesdocs/api/dotnet/webdriver/OpenQA.Selenium.BiDi.Script.Mode.html
ModeenumRemoteValue.csfile(two occurrences)
101 files