Skip to content

Commit 0737296

Browse files
authored
DOCSP-24855 adds Stable API options (#233)
* DOCSP-24855 adds Stable API options * restore * internal review
1 parent f9aba55 commit 0737296

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

source/reference/options.txt

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,36 @@ General Options
7676

7777
Returns the |mdb-shell| release number.
7878

79+
.. _mongosh-stable-api-options:
80+
81+
Stable API Options
82+
------------------
83+
84+
.. option:: --apiVersion <version number>
85+
86+
Specifies the :ref:`apiVersion <api-version-desc>`. ``"1"`` is
87+
currently the only supported value.
88+
89+
.. option:: --apiStrict
90+
91+
Specifies that the server will respond with :ref:`APIStrictError
92+
<api-strict-resp>` if your application uses a command or behavior
93+
outside of the :ref:`Stable API <stable-api>`.
94+
95+
If you specify :option:`--apiStrict`, you must also specify
96+
:option:`--apiVersion`.
97+
98+
.. option:: --apiDeprecationErrors
99+
100+
Specifies that the server will respond with :ref:`APIDeprecationError
101+
<api-deprecation-resp>` if your application uses a command or behavior
102+
that is deprecated in the specified ``apiVersion``.
103+
104+
If you specify :option:`--apiDeprecationErrors`, you must also
105+
specify :option:`--apiVersion`.
106+
107+
.. _mongosh-connection-options:
108+
79109
Connection Options
80110
------------------
81111

0 commit comments

Comments
 (0)