DOCSP-11299: [mongocli] mongocli atlas cluster(s) search index(es) list|ls (#166)

Author: steveren

source/reference/atlas/search-commands.txt

@@ -10,6 +10,7 @@ Atlas Search Commands
    :titlesonly:
 
    Create an Atlas Search Index </reference/atlas/search-index-create>
+   List Atlas Search Indexes </reference/atlas/search-index-list>
    Modify an Atlas Search Index </reference/atlas/search-index-update>
    Delete an Atlas Search Index </reference/atlas/search-index-delete>
 

source/reference/atlas/search-index-create.txt

@@ -1,8 +1,8 @@
 .. _mcli-atlas-search-index-create-command:
 
-===========================================
-mongocli atlas cluster searach index create
-===========================================
+==========================================
+mongocli atlas cluster search index create
+==========================================
 
 .. default-domain:: mongodb
 

source/reference/atlas/search-index-list.txt

@@ -0,0 +1,119 @@
+.. _mcli-atlas-search-index-list-command:
+
+========================================
+mongocli atlas cluster search index list
+========================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+The ``search index list`` command lists all |fts| :atlas:`indexes
+</reference/atlas-search/index-definitions/>` for a specified cluster. You
+can also list |fts| :atlas:`indexes
+</reference/atlas-search/index-management/>` through the |service| UI or the 
+:atlas:`API </reference/api/fts-indexes-get-all/>`.
+
+.. _mcli-atlas-search-index-list-syntax:
+
+Syntax 
+------
+
+.. code-block:: text 
+
+   mongocli atlas cluster search|fts index list|ls
+        --clusterName <cluster-name>
+        --db <database-name> 
+        --collection <collection-name>
+        [ --profile|-P <profile-name> ]
+        [ --projectId <project-ID> ]
+
+.. _mcli-atlas-search-index-list-options: 
+
+Options 
+-------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 60 10
+
+   * - Option
+     - Type
+     - Description
+     - Required?
+
+   * - ``--clusterName``
+     - string
+     - Name of the cluster. 
+     - yes
+
+   * - ``--db``
+     - string
+     - Name of the database that contains the collection.
+     - yes
+
+   * - ``--collection``
+     - string
+     - Name of the collection for which to list |fts| indexes.
+     - yes
+
+   * - ``--profile``, ``-P``
+     - string
+     - Name of the profile where the public and private keys for the project 
+       are set. If omitted, uses the {+default-profile+}. To learn more about 
+       creating a profile, see :ref:`mcli-configure`.
+     - no
+
+   * - ``--projectId``
+     - string
+     - Unique identifier of the project where you want to create the cluster. 
+       If omitted, uses the project ID in the profile or :ref:`environment 
+       variable <mcli-env-var>`.
+     - no
+
+.. _mcli-atlas-search-index-list-output:
+
+Output 
+------
+
+.. include:: /includes/command-output-intro.rst
+
+.. include:: /includes/atlas-search-index-output-fields.rst
+
+.. _mcli-atlas-search-index-list-egs:
+
+Example
+-------
+
+The following example uses the ``mongocli atlas cluster search index list`` 
+command to list the |fts| indexes on the ``sample_mflix.movies`` collection
+in an |service| cluster named ``myTestCluster``.
+
+.. code-block:: text 
+
+   mongocli atlas cluster search index list --clusterName myTestCluster --db sample_mflix --collection movies --profile egAtlasProfile
+
+The previous command prints the following fields in |json| format to the 
+terminal. To learn more about these fields, see 
+:ref:`mcli-atlas-search-index-list-output`.
+
+.. code-block:: json
+   :copyable: false
+
+   [
+     {
+       "analyzer": "lucene.standard",
+       "collectionName": "movies",
+       "database": "sample_mflix",
+       "indexID": "5f1f40842f2ac35f49190c20",
+       "mappings": {
+         "dynamic": true
+       },
+       "name": "dynamic",
+       "searchAnalyzer": "lucene.standard"
+     }
+   ]