Selenium · OpenAPI Overlay 1.0.0
API Evangelist enhancements — Selenium session api
7 actions
7 updates
update
extends
selenium-session-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Selenium's API. It is a proposal applied on top of the contract, not a document Selenium publishes.
What the actions change
400404405500x-reversibilityx-idempotentx-standardx-error-catalog
Targets 7
$.info
$
$.paths['/session'].post.responses
$.paths['/session'].post
$.paths['/session/{sessionId}'].delete.responses
$.paths['/session/{sessionId}'].delete
$.components.schemas
OpenAPI Overlay
# OpenAPI Overlay 1.0.0 — API Evangelist enhancements. Never mutate the source OpenAPI.
overlay: 1.0.0
info:
title: API Evangelist enhancements — Selenium session api
version: 1.0.0
extends: selenium-session-api-openapi.yml
x-generated: '2026-08-26'
x-method: generated
x-source: https://www.w3.org/TR/webdriver2/ (§ Errors) + conventions/selenium-conventions.yml
actions:
- target: $.info
description: Record the governing standard and the API Evangelist artifact set on the document itself.
update:
x-standard:
name: W3C WebDriver (WebDriver Level 2)
url: https://www.w3.org/TR/webdriver2/
role: Selenium is a co-author and reference implementation
x-error-catalog: errors/selenium-problem-types.yml
x-conventions: conventions/selenium-conventions.yml
x-authentication: authentication/selenium-authentication.yml
x-self-hosted: true
x-self-hosted-note: There is no vendor-operated host. The remote end runs on infrastructure the caller
owns; the documented default is http://localhost:4444.
- target: $
description: Point at the project documentation as external docs.
update:
externalDocs:
description: Selenium WebDriver documentation
url: https://www.selenium.dev/documentation/webdriver/
- target: $.paths['/session'].post.responses
description: Add the W3C WebDriver error responses the source document omits for createSession.
update:
'400':
description: invalid argument — The arguments passed to a command are either invalid or malformed.
content:
application/json:
schema:
$ref: '#/components/schemas/WebDriverError'
'404':
description: unknown command — A command could not be executed because the remote end is not aware
of it.
content:
application/json:
schema:
$ref: '#/components/schemas/WebDriverError'
'405':
description: unknown method — The requested command matched a known URL but did not match any method
for that URL.
content:
application/json:
schema:
$ref: '#/components/schemas/WebDriverError'
'500':
description: unknown error — An unknown error occurred in the remote end while processing the command.
content:
application/json:
schema:
$ref: '#/components/schemas/WebDriverError'
- target: $.paths['/session'].post
description: Record reversibility and idempotency semantics for createSession.
update:
x-reversibility:
reversible: true
reversal-operation: deleteSession
window: no time window stated by the provider
grade: documented
note: Terminates the session, quits the driver and removes it from the active sessions map.
x-idempotent: false
- target: $.paths['/session/{sessionId}'].delete.responses
description: Add the W3C WebDriver error responses the source document omits for deleteSession.
update:
'400':
description: invalid argument — The arguments passed to a command are either invalid or malformed.
content:
application/json:
schema:
$ref: '#/components/schemas/WebDriverError'
'404':
description: unknown command — A command could not be executed because the remote end is not aware
of it.
content:
application/json:
schema:
$ref: '#/components/schemas/WebDriverError'
'405':
description: unknown method — The requested command matched a known URL but did not match any method
for that URL.
content:
application/json:
schema:
$ref: '#/components/schemas/WebDriverError'
'500':
description: unknown error — An unknown error occurred in the remote end while processing the command.
content:
application/json:
schema:
$ref: '#/components/schemas/WebDriverError'
- target: $.paths['/session/{sessionId}'].delete
description: Record reversibility and idempotency semantics for deleteSession.
update:
x-reversibility:
reversible: null
grade: na
note: Read-only operation.
x-idempotent: true
- target: $.components.schemas
description: Add the W3C WebDriver error envelope schema, which the source document does not define.
update:
WebDriverError:
type: object
description: W3C WebDriver error envelope. Branch on value.error; value.message is implementation-defined.
properties:
value:
type: object
required:
- error
- message
- stacktrace
properties:
error:
type: string
description: The JSON error code, e.g. "no such element".
message:
type: string
stacktrace:
type: string
data:
type: object
description: 'Optional additional error data, e.g. {"text": "..."} for unexpected alert
open.'