DOCSP-11310: [mongocli] mongocli atlas cluster(s) search index(es) describe (#170)

Author: steveren

source/reference/atlas/search-commands.txt

@@ -11,6 +11,7 @@ Atlas Search Commands
 
    Create an Atlas Search Index </reference/atlas/search-index-create>
    List Atlas Search Indexes </reference/atlas/search-index-list>
+   Describe an Atlas Search Index </reference/atlas/search-index-describe>
    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-describe.txt

@@ -0,0 +1,110 @@
+.. _mcli-atlas-search-index-describe-command:
+
+============================================
+mongocli atlas cluster search index describe
+============================================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+The ``search index describe`` command retrieves one |fts| :atlas:`index
+</reference/atlas-search/index-definitions/>` for a specified cluster. You
+can also retrieve a single |fts| :atlas:`index
+</reference/atlas-search/index-management/>` through the |service| UI or the 
+:atlas:`API </reference/api/fts-indexes-get-one/>`.
+
+.. _mcli-atlas-search-index-describe-syntax:
+
+Syntax 
+------
+
+.. code-block:: text 
+
+   mongocli atlas cluster search|fts index describe <index-id>
+        --clusterName <cluster-name>
+        [ --profile|-P <profile-name> ]
+        [ --projectId <project-ID> ]
+
+.. _mcli-atlas-search-index-describe-options: 
+
+Options 
+-------
+
+.. list-table::
+   :header-rows: 1
+   :widths: 20 10 60 10
+
+   * - Option
+     - Type
+     - Description
+     - Required?
+
+   * - ``<index-id>``
+     - string
+     - Unique identifier of the |fts| index to describe. 
+     - yes
+
+   * - ``--clusterName``
+     - string
+     - Name of the cluster. 
+     - 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-describe-output:
+
+Output 
+------
+
+.. include:: /includes/command-output-intro.rst
+
+.. include:: /includes/atlas-search-index-output-fields.rst
+
+.. _mcli-atlas-search-index-describe-egs:
+
+Example
+-------
+
+The following example uses the ``mongocli atlas cluster search index describe``
+command to retrieve an |fts| index on an |service| cluster named
+``myTestCluster``.
+
+.. code-block:: text 
+
+   mongocli atlas cluster search index describe 5f1f40842f2ac35f49190c20 --clusterName myTestCluster -P 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-describe-output`.
+
+.. code-block:: json
+   :copyable: false
+
+   {
+     "analyzer": "lucene.standard",
+     "collectionName": "movies",
+     "database": "sample_mflix",
+     "indexID": "5f1f40842f2ac35f49190c20",
+     "mappings": {
+       "dynamic": true
+     },
+     "name": "dynamic",
+     "searchAnalyzer": "lucene.standard"
+   }