From 836a35c07fae2420590f90c33e7c65022e206da0 Mon Sep 17 00:00:00 2001 From: Jeremy Mikola Date: Tue, 2 Jan 2024 14:18:29 -0500 Subject: [PATCH] Document errorLabels option for failCommand fail point. --- source/unified-test-format/unified-test-format.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/source/unified-test-format/unified-test-format.rst b/source/unified-test-format/unified-test-format.rst index 72a9a691e8..dd6127e01b 100644 --- a/source/unified-test-format/unified-test-format.rst +++ b/source/unified-test-format/unified-test-format.rst @@ -3892,6 +3892,7 @@ The ``failCommand`` fail point may be configured like so:: failCommands: [, ...], closeConnection: , errorCode: , + errorLabels: [, ...], writeConcernError: , appName: , blockConnection: , @@ -3909,6 +3910,10 @@ if desired: * ``errorCode``: Optional integer, which is unset by default. If set, the command will not be executed and the specified command error code will be returned as a command error. +* ``errorLabels``: Optional array of strings. If set, this list overrides the + server's normal behavior for adding error labels. An empty array may be used + to suppress the server from adding error labels to the response. New in server + 4.3.1 (`SERVER-43941 `__). * ``appName``: Optional string, which is unset by default. If set, the fail point will only apply to connections for MongoClients created with this ``appname``. New in server 4.4.0-rc2 @@ -4061,6 +4066,7 @@ Changelog .. Please note schema version bumps in changelog entries where applicable. +:2024-01-02: Document ``errorLabels`` option for ``failCommand`` fail point. :2023-10-04: **Schema version 1.17.** Add ``serverHeartbeatStartedEvent``, ``serverHeartbeatSucceededEvent``, and ``serverHeartbeatFailedEvent`` for asserting on SDAM server heartbeat events.