Skip to content

Commit b4578ec

Browse files
(DOCSP-17541): Release notes & generated docs v1.19.0 (#546)
* (DOCSP-17541): Release notes & generated docs v1.19.0 * fix build errors
1 parent bba8bf3 commit b4578ec

File tree

535 files changed

+1230
-631
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

535 files changed

+1230
-631
lines changed

config/build_conf.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ system:
2929
- 'sphinx_local.yaml'
3030
- htaccess: ['htaccess.yaml']
3131
version:
32-
release: '1.18.0'
32+
release: '1.19.0'
3333
branch: 'master'
3434
assets:
3535
- branch: master

config/redirects

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
define: base https://docs.mongodb.com/mongocli
2-
define: versions v1.0.0 v1.1.0 v1.2.0 v1.3.0 v1.4.0 v1.5 v1.6 v1.7 v1.8 v1.9 v1.10 v1.11 v1.12 v1.13 v1.14 v1.15 v1.16 v1.17 v1.18 master
2+
define: versions v1.0.0 v1.1.0 v1.2.0 v1.3.0 v1.4.0 v1.5 v1.6 v1.7 v1.8 v1.9 v1.10 v1.11 v1.12 v1.13 v1.14 v1.15 v1.16 v1.17 v1.18 v1.19 master
33

44
raw: mongocli/ -> ${base}/stable/
55

snooty.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ data-lake-store = "data store"
174174
default-profile = ":ref:`default profile <mcli-profiles>`"
175175
mcli = "MongoDB CLI"
176176
mcli-long = "MongoDB Command Line Interface (``mongocli``)"
177-
mcli-version = "1.18.0"
177+
mcli-version = "1.19.0"
178178
mdbagent = "MongoDB Agent"
179179
mdbVersion = "5.0"
180180

source/command/mongocli-atlas-accessLists-create.txt

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,22 @@ Syntax
2121

2222
mongocli atlas accessLists create <entry> [options]
2323

24+
Arguments
25+
---------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - entry
36+
- string
37+
- false
38+
- The IP address, CIDR address, or AWS security group ID of the access list entry to create.
39+
2440
Options
2541
-------
2642

@@ -75,4 +91,4 @@ Inherited Options
7591
- false
7692
- Profile to use from your configuration file.
7793

78-
*Auto generated by MongoDB CLI on 8-Jul-2021*
94+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-accessLists-delete.txt

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,22 @@ Syntax
2121

2222
mongocli atlas accessLists delete <entry> [options]
2323

24+
Arguments
25+
---------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - entry
36+
- string
37+
- false
38+
- The IP address, CIDR address, or AWS security group ID of the access list entry to delete.
39+
2440
Options
2541
-------
2642

@@ -61,4 +77,4 @@ Inherited Options
6177
- false
6278
- Profile to use from your configuration file.
6379

64-
*Auto generated by MongoDB CLI on 8-Jul-2021*
80+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-accessLists-describe.txt

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,22 @@ Syntax
2121

2222
mongocli atlas accessLists describe <name> [options]
2323

24+
Arguments
25+
---------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - entry
36+
- string
37+
- false
38+
- The IP address, CIDR address, or AWS security group ID of the access list entry to retrieve.
39+
2440
Options
2541
-------
2642

@@ -62,4 +78,4 @@ Inherited Options
6278
- false
6379
- Profile to use from your configuration file.
6480

65-
*Auto generated by MongoDB CLI on 8-Jul-2021*
81+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-accessLists-list.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ Inherited Options
7070
- false
7171
- Profile to use from your configuration file.
7272

73-
*Auto generated by MongoDB CLI on 8-Jul-2021*
73+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-accessLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@ Related Commands
6363
describe </command/mongocli-atlas-accessLists-describe>
6464
list </command/mongocli-atlas-accessLists-list>
6565

66-
*Auto generated by MongoDB CLI on 8-Jul-2021*
66+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-alerts-acknowledge.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ Arguments
3232
- Type
3333
- Required
3434
- Description
35-
* - alertID
35+
* - alertId
3636
- string
3737
- false
38-
-
38+
- ID of the alert you want to acknowledge or un-acknowledge.
3939

4040
Options
4141
-------
@@ -90,4 +90,4 @@ Inherited Options
9090
- false
9191
- Profile to use from your configuration file.
9292

93-
*Auto generated by MongoDB CLI on 8-Jul-2021*
93+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-alerts-describe.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Syntax
1919

2020
.. code-block::
2121

22-
mongocli atlas alerts describe <alertID> [options]
22+
mongocli atlas alerts describe <alertId> [options]
2323

2424
Arguments
2525
---------
@@ -32,10 +32,10 @@ Arguments
3232
- Type
3333
- Required
3434
- Description
35-
* - alertID
35+
* - alertId
3636
- string
3737
- false
38-
-
38+
- Unique identifier of the alert you want to describe.
3939

4040
Options
4141
-------
@@ -78,4 +78,4 @@ Inherited Options
7878
- false
7979
- Profile to use from your configuration file.
8080

81-
*Auto generated by MongoDB CLI on 8-Jul-2021*
81+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-alerts-global-list.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ Inherited Options
7070
- false
7171
- Profile to use from your configuration file.
7272

73-
*Auto generated by MongoDB CLI on 8-Jul-2021*
73+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-alerts-global.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ Related Commands
5757

5858
list </command/mongocli-atlas-alerts-global-list>
5959

60-
*Auto generated by MongoDB CLI on 8-Jul-2021*
60+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-alerts-list.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,4 @@ Inherited Options
7474
- false
7575
- Profile to use from your configuration file.
7676

77-
*Auto generated by MongoDB CLI on 8-Jul-2021*
77+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-alerts-settings-create.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,4 +170,4 @@ Inherited Options
170170
- false
171171
- Profile to use from your configuration file.
172172

173-
*Auto generated by MongoDB CLI on 8-Jul-2021*
173+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-alerts-settings-delete.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Arguments
3535
* - alertConfigId
3636
- string
3737
- false
38-
-
38+
- ID of the alert configuration to delete.
3939

4040
Options
4141
-------
@@ -77,4 +77,4 @@ Inherited Options
7777
- false
7878
- Profile to use from your configuration file.
7979

80-
*Auto generated by MongoDB CLI on 8-Jul-2021*
80+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-alerts-settings-fields-type.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@ Inherited Options
5858
- false
5959
- Profile to use from your configuration file.
6060

61-
*Auto generated by MongoDB CLI on 8-Jul-2021*
61+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-alerts-settings-fields.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ Related Commands
5757

5858
type </command/mongocli-atlas-alerts-settings-fields-type>
5959

60-
*Auto generated by MongoDB CLI on 8-Jul-2021*
60+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-alerts-settings-list.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ Inherited Options
7070
- false
7171
- Profile to use from your configuration file.
7272

73-
*Auto generated by MongoDB CLI on 8-Jul-2021*
73+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-alerts-settings-update.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Arguments
3535
* - alertConfigId
3636
- string
3737
- false
38-
-
38+
- Unique identifier of the alert configuration you want to update.
3939

4040
Options
4141
-------
@@ -186,4 +186,4 @@ Inherited Options
186186
- false
187187
- Profile to use from your configuration file.
188188

189-
*Auto generated by MongoDB CLI on 8-Jul-2021*
189+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-alerts-settings.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,4 @@ Related Commands
6868
list </command/mongocli-atlas-alerts-settings-list>
6969
update </command/mongocli-atlas-alerts-settings-update>
7070

71-
*Auto generated by MongoDB CLI on 8-Jul-2021*
71+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-alerts-unacknowledge.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ Arguments
3232
- Type
3333
- Required
3434
- Description
35-
* - alertID
35+
* - alertId
3636
- string
3737
- false
38-
-
38+
- ID of the alert you want to unacknowledge.
3939

4040
Options
4141
-------
@@ -82,4 +82,4 @@ Inherited Options
8282
- false
8383
- Profile to use from your configuration file.
8484

85-
*Auto generated by MongoDB CLI on 8-Jul-2021*
85+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-alerts.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,4 @@ Related Commands
6767
settings </command/mongocli-atlas-alerts-settings>
6868
unacknowledge </command/mongocli-atlas-alerts-unacknowledge>
6969

70-
*Auto generated by MongoDB CLI on 8-Jul-2021*
70+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-backups-restores-list.txt

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,22 @@ Syntax
2121

2222
mongocli atlas backups restores list <clusterName> [options]
2323

24+
Arguments
25+
---------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - clusterName
36+
- string
37+
- false
38+
- Name of the Atlas cluster for which you want to retrieve restore jobs.
39+
2440
Options
2541
-------
2642

@@ -70,4 +86,4 @@ Inherited Options
7086
- false
7187
- Profile to use from your configuration file.
7288

73-
*Auto generated by MongoDB CLI on 8-Jul-2021*
89+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-backups-restores-start.txt

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,22 @@ Syntax
2121

2222
mongocli atlas backups restores start <automated|download|pointInTime> [options]
2323

24+
Arguments
25+
---------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - deliveryType
36+
- string
37+
- false
38+
- Type of restore job to create. Accepted values include: automated, download, pointInTime.
39+
2440
Options
2541
-------
2642

@@ -94,4 +110,4 @@ Inherited Options
94110
- false
95111
- Profile to use from your configuration file.
96112

97-
*Auto generated by MongoDB CLI on 8-Jul-2021*
113+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-backups-restores.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,4 @@ Related Commands
5959
list </command/mongocli-atlas-backups-restores-list>
6060
start </command/mongocli-atlas-backups-restores-start>
6161

62-
*Auto generated by MongoDB CLI on 8-Jul-2021*
62+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-backups-snapshots-create.txt

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,22 @@ Syntax
2121

2222
mongocli atlas backups snapshots create <clusterName> [options]
2323

24+
Arguments
25+
---------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - clusterName
36+
- string
37+
- false
38+
- Name of the Atlas cluster whose snapshot you want to restore.
39+
2440
Options
2541
-------
2642

@@ -70,4 +86,4 @@ Inherited Options
7086
- false
7187
- Profile to use from your configuration file.
7288

73-
*Auto generated by MongoDB CLI on 8-Jul-2021*
89+
*Auto generated by cobra2snooty on 13-Jul-2021*

source/command/mongocli-atlas-backups-snapshots-delete.txt

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,22 @@ Syntax
2121

2222
mongocli atlas backups snapshots delete <snapshotId> [options]
2323

24+
Arguments
25+
---------
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 20 10 10 60
30+
31+
* - Name
32+
- Type
33+
- Required
34+
- Description
35+
* - snapshotId
36+
- string
37+
- false
38+
- Unique identifier of the snapshot you want to delete.
39+
2440
Options
2541
-------
2642

@@ -65,4 +81,4 @@ Inherited Options
6581
- false
6682
- Profile to use from your configuration file.
6783

68-
*Auto generated by MongoDB CLI on 8-Jul-2021*
84+
*Auto generated by cobra2snooty on 13-Jul-2021*

0 commit comments

Comments
 (0)