From 10344ac31c4f0e0d0d848f815435ebe2a6891f4a Mon Sep 17 00:00:00 2001
From: Mykola Mokhnach <mokhnach@gmail.com>
Date: Thu, 12 Sep 2024 19:36:45 +0200
Subject: [PATCH] docs: Document supported BiDi entities (#2465)

---
 docs/reference/bidi.md | 47 ++++++++++++++++++++++++++++++++++++++++++
 mkdocs.yml             |  1 +
 2 files changed, 48 insertions(+)
 create mode 100644 docs/reference/bidi.md

diff --git a/docs/reference/bidi.md b/docs/reference/bidi.md
new file mode 100644
index 000000000..dbfd76915
--- /dev/null
+++ b/docs/reference/bidi.md
@@ -0,0 +1,47 @@
+---
+title: BiDi Protocol Support
+---
+
+XCUITest driver has partial support of the [BiDi Protocol](https://w3c.github.io/webdriver-bidi/) since version 7.26.0.
+Only events and commands mentioned below are supported.
+All other entities described in the spec throw not implemented errors.
+
+# Supported Events
+
+## log.entryAdded
+
+This event is emitted if the driver retrieves a new entry for any of the below log types. Logs collection might be disabled by the `appium:skipLogCapture` capability.
+
+### crashlog
+
+Events are emitted for both emulator and real devices. The latter only works if [py-ios-device](https://github.com/YueChen-C/py-ios-device) is installed on the server host. Each event contains a particular device crash report entry.
+Events are always emitted with the `NATIVE_APP` context.
+
+### syslog
+
+Events are emitted for both emulator and real devices. Each event contains a single device system log line.
+Events are always emitted with the `NATIVE_APP` context.
+
+### safariConsole
+
+Events are emitted for both emulator and real devices. Each event contains a single Safari console log line.
+Events are always emitted with the appropriate web context name from which they were generated.
+Events are only emitted if the `appium:showSafariConsoleLog` capability value is provided.
+
+### safariNetwork
+
+Events are emitted for both emulator and real devices. Each event contains a single Safari network log line.
+Events are always emitted with the appropriate web context name from which they were generated.
+Events are only emitted if the `appium:showSafariNetworkLog` capability value is provided.
+
+### performance
+
+Events are emitted for both emulator and real devices. Each event contains a single Safari performance log line.
+Events are always emitted with the appropriate web context name from which they were generated.
+Events are only emitted if the `appium:enablePerformanceLogging` capability value is provided.
+
+### server
+
+Events are emitted for both emulator and real devices. Each event contains a single Appium server log line.
+Events are always emitted with the `NATIVE_APP` context.
+Events are only emitted if the `get_server_logs` server security feature is enabled.
diff --git a/mkdocs.yml b/mkdocs.yml
index 54731fc30..b10b0a140 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
           - preparation/prov-profile-generic-manual.md
   - Reference:
       - reference/scripts.md
+      - reference/bidi.md
       - Server Configuration:
           - reference/server-args.md
           - reference/security-flags.md