Merge pull request #134 from davidhou17/DOCSP-29111

(DOCSP-29111): Add info on how to use the Open API spec to create JSON config files

Author: davidhou17

snooty.toml

@@ -18,6 +18,7 @@ toc_landing_pages = [
   "/connect-atlas-cli",
   "/install-atlas-cli",
   "/migrate-to-atlas-cli",
+  "/reference/json",
   "/telemetry"
   ]
 

source/reference/json.txt

@@ -1,8 +1,107 @@
+.. _json-cluster-config:
 
 ======
 |json|
 ======
 
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+If an {+atlas-cli+} command accepts the ``--file`` option, you can pass 
+a ``.json`` configuration file to define specific settings. For example, 
+you can pass a configuration file when using the {+atlas-cli+} to:
+
+- :ref:`Create <atlas-clusters-create>`, :ref:`update <atlas-clusters-update>`, 
+  or :ref:`upgrade a cluster <atlas-clusters-upgrade>`.
+- :ref:`Update a cloud backup schedule <atlas-backups-schedule-update>`.
+- :ref:`Create <atlas-clusters-search-indexes-create>` or 
+  :ref:`update an Atlas Search Index <atlas-clusters-search-indexes-update>`.
+
+Usage
+-----
+
+To learn which settings are accepted by the {+atlas-cli+}, view the request 
+body schema and copy the request samples in the :ref:`Atlas Admin API Specification 
+<api-resources-spec>` for the endpoint that corresponds to the {+atlas-cli+} 
+command. The commands you can use include but are not limited to:
+
+.. list-table::
+  :header-rows: 1
+  :widths: 50 50
+          
+  * - {+atlas-cli+} Command
+    - API Endpoint
+
+  * - :ref:`atlas-clusters-create`
+    - :oas-atlas-op:`Create One Cluster </createLegacyCluster>`
+
+  * - :ref:`atlas-clusters-update`
+    - :oas-atlas-op:`Update Configuration of One Cluster </updateClusterConfiguration>`
+
+  * - :ref:`atlas-clusters-upgrade`
+    - :oas-atlas-op:`Upgrade One Shared-tier Cluster </upgradeSharedCluster>`
+
+  * - :ref:`atlas-backups-schedule-update`
+    - :oas-atlas-op:`Update Cloud Backup Schedule for One Cluster </updateBackupSchedule>`
+
+  * - :ref:`atlas-clusters-search-indexes-create`
+    - :oas-atlas-op:`Create One Atlas Search Index </createAtlasSearchIndex>`
+
+  * - :ref:`atlas-clusters-search-indexes-update`
+    - :oas-atlas-op:`Update One Atlas Search Index </updateAtlasSearchIndex>`
+
+When you run the command in your terminal, specify the ``--file`` option 
+and provide the path to the |json| configuration file that defines your 
+desired settings. 
+
+Example
+~~~~~~~
+
+For example, consider the following configuration file
+to enable backups and add a label:
+
+.. code-block:: sh
+   :caption: /example.json
+
+   {
+     "backupEnabled" : true,
+     "labels": [
+       {
+         "key": "<myKey>",
+         "value": "<myValue>"
+       }
+     ]
+   } 
+
+The following command updates the ``myCluster`` deployment
+based on the settings specified in the configuration file:
+
+.. code-block:: sh
+
+   atlas clusters update myCluster --file /example.json
+
+{+Cluster+} Configuration File
+------------------------------
+
+To learn more about {+cluster+} configuration files, see 
+:ref:`atlas-cli-cluster-config-file`. For sample files,
+see:
+
+- :ref:`example-cluster-config-file`
+- :ref:`multi-cloud-example-cluster-config-file`
+- :ref:`geosharded-example-cluster-config-file`
+
+
+Cloud Backup Schedule Configuration File
+----------------------------------------
+
+To learn more about cloud backup schedule configuration files, see 
+:ref:`atlas-cli-cloud-backup-schedule-config-file`. For a sample file,
+see :ref:`example-cloud-backup-schedule-config-file`.
+
 .. toctree::
    :titlesonly:
 

source/reference/json/cluster-config-file.txt

@@ -210,6 +210,8 @@ following example file:
 
 .. literalinclude:: /includes/json-cluster-config-file-multi.json
 
+.. _geosharded-example-cluster-config-file:
+
 Example Geosharded Cluster Configuration File
 ---------------------------------------------