Skip to content

Commit fa79c84

Browse files
DOCSP-34286 -- incorporate internal review feedback
1 parent 16ae81e commit fa79c84

File tree

1 file changed

+26
-17
lines changed

1 file changed

+26
-17
lines changed

source/reference/json/file-options-online-archive.txt

Lines changed: 26 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,25 @@ Online Archive Configuration File
1010
:depth: 1
1111
:class: singlecol
1212

13-
You can use an Online Archive configuration file to specify the required
14-
settings for creating and updating an Online Archive. This archive stores
15-
data from one cluster within one project. To use this resource, the
16-
requesting API Key must have the Project Data Access Admin role.
13+
You can use a configuration file to specify the required
14+
settings for creating and updating an online archive using the
15+
{+atlas-cli+}. The {+atlas-cli+} accepts ``.json`` online archive
16+
configuration files.
1717

1818
Use the following resources to:
1919

20-
- Learn the required settings you can specify in the Online Archive
21-
configuration file.
20+
- Learn the :ref:`required settings <required-oa-settings>` you
21+
can specify in the online archive
2222

2323
- View and copy sample configuration files.
2424

25+
.. _required-oa-settings:
26+
2527
Required Online Archive Create and Update Settings
2628
--------------------------------------------------
2729

28-
|service| requires the following settings to create an Online Archive with
29-
the {+atlas-cli+}. You must specify these Online Archive settings either
30+
|service| requires the following settings to create an online archive with
31+
the {+atlas-cli+}. You must specify these online archive settings either
3032
in the configuration file or as flags in the command:
3133

3234
.. list-table::
@@ -39,21 +41,20 @@ in the configuration file or as flags in the command:
3941

4042
* - ``groupId``
4143
- string
42-
- Unique identifier for your project. Your group id is the same
43-
as your project id. For existing groups, your group/project id
44+
- Unique identifier for your project. Your ``groupId`` is the same
45+
as your ``projectId``. For existing groups, your group/project id
4446
remains the same. The resource and corresponding
4547
endpoints use the term groups.
4648

4749
* - ``archiveID``
4850
- string
4951
- Unique 24-hexadecimal digit string that identifies
50-
the online archive to update. This param is required for updating an
51-
existing Online Archive.
52+
the online archive to update.
5253

5354
* - ``clusterName``
5455
- string
5556
- Human-readable label that identifies the cluster that contains
56-
the collection for which you want to create one online archive.
57+
the collection for which you want to create or update one online archive.
5758

5859
* - ``collName``
5960
- string
@@ -73,19 +74,27 @@ For a full list of available settings, see the API documentation for
7374

7475
Example Online Archive Create Command
7576
-------------------------------------
76-
After you create the file, run the command to create the Online Archive.
77+
To create an online archive configuration, specify the ``--file`` option
78+
and the path to the file. The following example creates an
79+
online archive by using a configuration file named
80+
``online-archive-create-config.json``:
7781

7882
.. code-block::
7983

80-
atlas clusters onlineArchive create --file online-archive-create.json --output json
84+
atlas clusters onlineArchive create --file online-archive-create-config.json --output json
8185

8286
Example Online Archive Update Command
8387
-------------------------------------
84-
After you create the file, run the command to update the Online Archive.
88+
To update an online archive configuration, specify the ``--file`` option
89+
and the path to the file. The following example updates an
90+
online archive by using a configuration file named
91+
``online-archive-update-config.json``:
8592

8693
.. code-block::
8794

88-
atlas clusters onlineArchive update --file online-archive-update.json --output json
95+
atlas clusters onlineArchive update --file online-archive-update-config.json --output json
96+
97+
.. _example-oa-config-file:
8998

9099
Example Online Archive Create Configuration File
91100
------------------------------------------------

0 commit comments

Comments
 (0)