Skip to content

Commit c0b920c

Browse files
authored
fix: missing docs in auto-generated commands (#4252)
1 parent 9d8c49d commit c0b920c

File tree

589 files changed

+4608
-2011
lines changed

Some content is hidden

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

589 files changed

+4608
-2011
lines changed

docs/command/atlas-api-accessTracking-getAccessHistoryCluster.txt

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,35 +47,37 @@ Options
4747
* - --authResult
4848
-
4949
- false
50-
- flag that indicates whether the response returns the successful authentication attempts only
50+
- Flag that indicates whether the response returns the successful authentication attempts only.
5151
* - --clusterName
5252
- string
5353
- true
54-
- human-readable label that identifies the cluster
54+
- Human-readable label that identifies the cluster.
5555
* - --end
5656
- int
5757
- false
58-
- date and time when to stop retrieving database history
58+
- Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.
5959
* - --envelope
60-
-
60+
- envelope
6161
- false
62-
- flag that indicates whether Application wraps the response in an envelope JSON object
62+
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
6363
* - --groupId
6464
- string
6565
- true
66-
- unique 24-hexadecimal digit string that identifies your project
66+
- Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
67+
68+
**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
6769
* - -h, --help
6870
-
6971
- false
7072
- help for getAccessHistoryCluster
7173
* - --ipAddress
7274
- string
7375
- false
74-
- one Internet Protocol address that attempted to authenticate with the database
76+
- One Internet Protocol address that attempted to authenticate with the database.
7577
* - --nLogs
7678
- int
7779
- false
78-
- maximum number of lines from the log to return
80+
- Maximum number of lines from the log to return.
7981
* - -o, --output
8082
- string
8183
- false
@@ -87,11 +89,11 @@ Options
8789
* - --pretty
8890
-
8991
- false
90-
- flag that indicates whether the response body should be in the prettyprint format
92+
- Flag that indicates whether the response body should be in the prettyprint format.
9193
* - --start
9294
- int
9395
- false
94-
- date and time when MongoDB Cloud begins retrieving database history
96+
- Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.
9597
* - --version
9698
- string
9799
- false
@@ -113,3 +115,8 @@ Inherited Options
113115
- false
114116
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
115117

118+
Examples
119+
--------
120+
121+
.. literalinclude:: /includes/examples/atlas-api-accessTracking-getAccessHistoryCluster-2023-01-01-default.sh
122+
:language: shell

docs/command/atlas-api-accessTracking-getAccessHistoryProcess.txt

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,35 +47,37 @@ Options
4747
* - --authResult
4848
-
4949
- false
50-
- flag that indicates whether the response returns the successful authentication attempts only
50+
- Flag that indicates whether the response returns the successful authentication attempts only.
5151
* - --end
5252
- int
5353
- false
54-
- date and time when to stop retrieving database history
54+
- Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.
5555
* - --envelope
56-
-
56+
- envelope
5757
- false
58-
- flag that indicates whether Application wraps the response in an envelope JSON object
58+
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
5959
* - --groupId
6060
- string
6161
- true
62-
- unique 24-hexadecimal digit string that identifies your project
62+
- Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
63+
64+
**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
6365
* - -h, --help
6466
-
6567
- false
6668
- help for getAccessHistoryProcess
6769
* - --hostname
6870
- string
6971
- true
70-
- fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download
72+
- Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download.
7173
* - --ipAddress
7274
- string
7375
- false
74-
- one Internet Protocol address that attempted to authenticate with the database
76+
- One Internet Protocol address that attempted to authenticate with the database.
7577
* - --nLogs
7678
- int
7779
- false
78-
- maximum number of lines from the log to return
80+
- Maximum number of lines from the log to return.
7981
* - -o, --output
8082
- string
8183
- false
@@ -87,11 +89,11 @@ Options
8789
* - --pretty
8890
-
8991
- false
90-
- flag that indicates whether the response body should be in the prettyprint format
92+
- Flag that indicates whether the response body should be in the prettyprint format.
9193
* - --start
9294
- int
9395
- false
94-
- date and time when MongoDB Cloud begins retrieving database history
96+
- Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds.
9597
* - --version
9698
- string
9799
- false
@@ -113,3 +115,8 @@ Inherited Options
113115
- false
114116
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
115117

118+
Examples
119+
--------
120+
121+
.. literalinclude:: /includes/examples/atlas-api-accessTracking-getAccessHistoryProcess-2023-01-01-default.sh
122+
:language: shell

docs/command/atlas-api-alertConfigurations-createAlertConfig.txt

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,19 @@ Options
4848
- Required
4949
- Description
5050
* - --envelope
51-
-
51+
- envelope
5252
- false
53-
- flag that indicates whether Application wraps the response in an envelope JSON object
53+
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
5454
* - --file
5555
- string
5656
- false
5757
- path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both.
5858
* - --groupId
5959
- string
6060
- true
61-
- unique 24-hexadecimal digit string that identifies your project
61+
- Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
62+
63+
**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
6264
* - -h, --help
6365
-
6466
- false
@@ -74,7 +76,7 @@ Options
7476
* - --pretty
7577
-
7678
- false
77-
- flag that indicates whether the response body should be in the prettyprint format
79+
- Flag that indicates whether the response body should be in the prettyprint format.
7880
* - --version
7981
- string
8082
- false

docs/command/atlas-api-alertConfigurations-deleteAlertConfig.txt

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,17 @@ Options
5050
* - --alertConfigId
5151
- string
5252
- true
53-
- unique 24-hexadecimal digit string that identifies the alert configuration
53+
- Unique 24-hexadecimal digit string that identifies the alert configuration.
5454
* - --envelope
55-
-
55+
- envelope
5656
- false
57-
- flag that indicates whether Application wraps the response in an envelope JSON object
57+
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
5858
* - --groupId
5959
- string
6060
- true
61-
- unique 24-hexadecimal digit string that identifies your project
61+
- Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
62+
63+
**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
6264
* - -h, --help
6365
-
6466
- false
@@ -74,7 +76,7 @@ Options
7476
* - --pretty
7577
-
7678
- false
77-
- flag that indicates whether the response body should be in the prettyprint format
79+
- Flag that indicates whether the response body should be in the prettyprint format.
7880
* - --version
7981
- string
8082
- false
@@ -96,3 +98,8 @@ Inherited Options
9698
- false
9799
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
98100

101+
Examples
102+
--------
103+
104+
.. literalinclude:: /includes/examples/atlas-api-alertConfigurations-deleteAlertConfig-2023-01-01-default.sh
105+
:language: shell

docs/command/atlas-api-alertConfigurations-getAlertConfig.txt

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,17 @@ Options
5050
* - --alertConfigId
5151
- string
5252
- true
53-
- unique 24-hexadecimal digit string that identifies the alert configuration
53+
- Unique 24-hexadecimal digit string that identifies the alert configuration.
5454
* - --envelope
55-
-
55+
- envelope
5656
- false
57-
- flag that indicates whether Application wraps the response in an envelope JSON object
57+
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
5858
* - --groupId
5959
- string
6060
- true
61-
- unique 24-hexadecimal digit string that identifies your project
61+
- Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
62+
63+
**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
6264
* - -h, --help
6365
-
6466
- false
@@ -74,7 +76,7 @@ Options
7476
* - --pretty
7577
-
7678
- false
77-
- flag that indicates whether the response body should be in the prettyprint format
79+
- Flag that indicates whether the response body should be in the prettyprint format.
7880
* - --version
7981
- string
8082
- false
@@ -96,3 +98,8 @@ Inherited Options
9698
- false
9799
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
98100

101+
Examples
102+
--------
103+
104+
.. literalinclude:: /includes/examples/atlas-api-alertConfigurations-getAlertConfig-2023-01-01-default.sh
105+
:language: shell

docs/command/atlas-api-alertConfigurations-getAlertConfigs.txt

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,27 +50,29 @@ Options
5050
* - --alertId
5151
- string
5252
- true
53-
- unique 24-hexadecimal digit string that identifies the alert
53+
- Unique 24-hexadecimal digit string that identifies the alert.
5454
* - --envelope
55-
-
55+
- envelope
5656
- false
57-
- flag that indicates whether Application wraps the response in an envelope JSON object
57+
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
5858
* - --groupId
5959
- string
6060
- true
61-
- unique 24-hexadecimal digit string that identifies your project
61+
- Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
62+
63+
**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
6264
* - -h, --help
6365
-
6466
- false
6567
- help for getAlertConfigs
6668
* - --includeCount
6769
-
6870
- false
69-
- flag that indicates whether the response returns the total number of items (totalCount) in the response
71+
- Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.
7072
* - --itemsPerPage
7173
- int
7274
- false
73-
- number of items that the response returns per page
75+
- Number of items that the response returns per page.
7476
* - -o, --output
7577
- string
7678
- false
@@ -82,11 +84,11 @@ Options
8284
* - --pageNum
8385
- int
8486
- false
85-
- number of the page that displays the current set of the total objects that the response returns
87+
- Number of the page that displays the current set of the total objects that the response returns.
8688
* - --pretty
8789
-
8890
- false
89-
- flag that indicates whether the response body should be in the prettyprint format
91+
- Flag that indicates whether the response body should be in the prettyprint format.
9092
* - --version
9193
- string
9294
- false
@@ -108,3 +110,8 @@ Inherited Options
108110
- false
109111
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
110112

113+
Examples
114+
--------
115+
116+
.. literalinclude:: /includes/examples/atlas-api-alertConfigurations-getAlertConfigs-2023-01-01-default.sh
117+
:language: shell

docs/command/atlas-api-alertConfigurations-listAlertConfigs.txt

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -48,25 +48,27 @@ Options
4848
- Required
4949
- Description
5050
* - --envelope
51-
-
51+
- envelope
5252
- false
53-
- flag that indicates whether Application wraps the response in an envelope JSON object
53+
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
5454
* - --groupId
5555
- string
5656
- true
57-
- unique 24-hexadecimal digit string that identifies your project
57+
- Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
58+
59+
**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
5860
* - -h, --help
5961
-
6062
- false
6163
- help for listAlertConfigs
6264
* - --includeCount
6365
-
6466
- false
65-
- flag that indicates whether the response returns the total number of items (totalCount) in the response
67+
- Flag that indicates whether the response returns the total number of items (**totalCount**) in the response.
6668
* - --itemsPerPage
6769
- int
6870
- false
69-
- number of items that the response returns per page
71+
- Number of items that the response returns per page.
7072
* - -o, --output
7173
- string
7274
- false
@@ -78,11 +80,11 @@ Options
7880
* - --pageNum
7981
- int
8082
- false
81-
- number of the page that displays the current set of the total objects that the response returns
83+
- Number of the page that displays the current set of the total objects that the response returns.
8284
* - --pretty
8385
-
8486
- false
85-
- flag that indicates whether the response body should be in the prettyprint format
87+
- Flag that indicates whether the response body should be in the prettyprint format.
8688
* - --version
8789
- string
8890
- false
@@ -104,3 +106,8 @@ Inherited Options
104106
- false
105107
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
106108

109+
Examples
110+
--------
111+
112+
.. literalinclude:: /includes/examples/atlas-api-alertConfigurations-listAlertConfigs-2023-01-01-default.sh
113+
:language: shell

docs/command/atlas-api-alertConfigurations-listMatcherFieldNames.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ Options
4545
- Required
4646
- Description
4747
* - --envelope
48-
-
48+
- envelope
4949
- false
50-
- flag that indicates whether Application wraps the response in an envelope JSON object
50+
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
5151
* - -h, --help
5252
-
5353
- false
@@ -63,7 +63,7 @@ Options
6363
* - --pretty
6464
-
6565
- false
66-
- flag that indicates whether the response body should be in the prettyprint format
66+
- Flag that indicates whether the response body should be in the prettyprint format.
6767
* - --version
6868
- string
6969
- false

0 commit comments

Comments
 (0)