@@ -20,16 +20,16 @@ Use the following resources to:
20
20
- Learn the :ref:`required settings <required-oa-settings>` you
21
21
can specify in the online archive
22
22
23
- - View and copy sample configuration files.
23
+ - View and copy :ref:` sample configuration files <example-oa-config-file>` .
24
24
25
25
.. _required-oa-settings:
26
26
27
- Required Online Archive Create and Update Settings
28
- --------------------------------------------------
27
+ Online Archive Settings
28
+ -----------------------
29
29
30
- |service| requires the following settings to create an online archive with
31
- the {+atlas-cli+}. You must specify these online archive settings either
32
- in the configuration file or as flags in the command:
30
+ You can specify the following settings to create or
31
+ update an online archive either in the configuration
32
+ file or as flags in the command:
33
33
34
34
.. list-table::
35
35
:header-rows: 1
@@ -69,8 +69,23 @@ in the configuration file or as flags in the command:
69
69
- Human-readable label of the database that
70
70
contains the collection that contains the online archive.
71
71
72
- For a full list of available settings, see the API documentation for
73
- :oas-atlas-op:`Create One Online Archive<>`.
72
+ For detailed descriptions and a full list of available settings,
73
+ see the request body schema in the API specification:
74
+ - :oas-atlas-op:`Create One Online Archive </createOnlineArchive>`
75
+ - :oas-atlas-op:`Update One Online Archive </updateOnlineArchive>`
76
+
77
+ .. _example-oa-config-file:
78
+
79
+ Example Online Archive Create Configuration File
80
+ ------------------------------------------------
81
+
82
+ .. literalinclude:: /includes/online-archive-create.json
83
+
84
+
85
+ Example Online Archive Update Configuration File
86
+ ------------------------------------------------
87
+
88
+ .. literalinclude:: /includes/online-archive-update.json
74
89
75
90
Example Online Archive Create Command
76
91
-------------------------------------
@@ -94,15 +109,5 @@ online archive by using a configuration file named
94
109
95
110
atlas clusters onlineArchive update --file online-archive-update-config.json --output json
96
111
97
- .. _example-oa-config-file:
98
-
99
- Example Online Archive Create Configuration File
100
- ------------------------------------------------
101
112
102
- .. literalinclude:: /includes/online-archive-create.json
103
113
104
-
105
- Example Online Archive Update Configuration File
106
- ------------------------------------------------
107
-
108
- .. literalinclude:: /includes/online-archive-update.json
0 commit comments