DOCSP-33422 Add Stable API Explain Content (#5831) (#6181)

* DOCSP-33422 Add Stable API Explain Content

* *

* *

* *

* *

* XR Comments

* XR

* *

* Update source/reference/command/explain.txt



---------

Co-authored-by: Nick Villahermosa <nick.villahermosa@mongodb.com>

Author: ianf-mongodb

source/includes/fact-stable-api-explain.rst

@@ -0,0 +1,2 @@
+MongoDB does not guarantee any specific output format from the 
+:dbcommand:`explain` command, even when using the Stable API.

source/reference/command/explain.txt

@@ -137,6 +137,20 @@ For write operations, the :dbcommand:`explain` command returns
 information about the write operation that would be performed but does
 not actually modify the database.
 
+Stable API
+~~~~~~~~~~
+
+The :ref:`Stable API <stable-api>` V1 supports the following
+verbosity modes for the ``explain`` command:
+
+- :ref:`allPlansExecution <ex-allPlansExecution>`
+- :ref:`executionStats <ex-executionStats>`
+- :ref:`queryPlanner<ex-queryPlanner>`
+
+.. warning::
+
+   .. include:: /includes/fact-stable-api-explain.rst
+
 Restrictions
 ~~~~~~~~~~~~
 
@@ -174,8 +188,8 @@ verbosity mode to return the query planning information for a
 
 .. _ex-executionStats:
 
-``executionStats``  Mode
-~~~~~~~~~~~~~~~~~~~~~~~~
+``executionStats`` Mode
+~~~~~~~~~~~~~~~~~~~~~~~
 
 The following :dbcommand:`explain` operation runs in ``"executionStats"``
 verbosity mode to return the query planning and execution information

source/reference/stable-api-changelog.txt

@@ -126,9 +126,7 @@ The following table describes:
 
 .. [#stable-api-explain]
 
-   MongoDB does not guarantee that the output of the
-   :dbcommand:`explain` command will conform to the same format in
-   future API versions.
+   .. include:: /includes/fact-stable-api-explain.rst
 
 Aggregation Stages and Operators
 --------------------------------