Skip to content

Commit b90fc3e

Browse files
CLOUDP-311982: Update Autogenerated Commands (#3817)
Co-authored-by: apix-bot[bot] <168195273+apix-bot[bot]@users.noreply.github.com>
1 parent 51b3b66 commit b90fc3e

File tree

449 files changed

+4380
-5498
lines changed

Some content is hidden

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

449 files changed

+4380
-5498
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ atlas api accessTracking listAccessLogsByClusterName
1414

1515
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the access logs of one cluster identified by the cluster's name.
1616

17-
Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role or the Project Database Access Admin role.
17+
Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role.
1818

1919
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName.
2020

@@ -86,7 +86,7 @@ Options
8686
* - --pretty
8787
-
8888
- false
89-
- Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
89+
- Flag that indicates whether the response body should be in the prettyprint format.
9090
* - --start
9191
- int
9292
- false
@@ -119,7 +119,7 @@ Run the command below.
119119

120120
.. code-block::
121121

122-
atlas api accessTracking listAccessLogsByClusterName --version 2023-01-01 --clusterName [clusterName] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false
122+
atlas api accessTracking listAccessLogsByClusterName --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8
123123

124124
.. Code end marker, please don't delete this comment
125125

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ atlas api accessTracking listAccessLogsByHostname
1414

1515
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the access logs of one cluster identified by the cluster's hostname.
1616

17-
Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role or the Project Database Access Admin role.
17+
Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role or the Project Database Access Admin role.
1818

1919
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname.
2020

@@ -86,7 +86,7 @@ Options
8686
* - --pretty
8787
-
8888
- false
89-
- Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
89+
- Flag that indicates whether the response body should be in the prettyprint format.
9090
* - --start
9191
- int
9292
- false
@@ -119,7 +119,7 @@ Run the command below.
119119

120120
.. code-block::
121121

122-
atlas api accessTracking listAccessLogsByHostname --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --hostname [hostname] --pretty false
122+
atlas api accessTracking listAccessLogsByHostname --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --hostname [hostname]
123123

124124
.. Code end marker, please don't delete this comment
125125

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ atlas api alertConfigurations createAlertConfiguration
1414

1515
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one alert configuration for the specified project.
1616

17-
Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
17+
Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role.
1818

1919

2020
This resource remains under revision and may change.
@@ -73,7 +73,7 @@ Options
7373
* - --pretty
7474
-
7575
- false
76-
- Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
76+
- Flag that indicates whether the response body should be in the prettyprint format.
7777
* - --version
7878
- string
7979
- false

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ atlas api alertConfigurations deleteAlertConfiguration
1414

1515
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Removes one alert configuration from the specified project.
1616

17-
To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
17+
To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access.
1818

1919

2020
This resource remains under revision and may change.
@@ -47,7 +47,7 @@ Options
4747
* - --alertConfigId
4848
- string
4949
- true
50-
- Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.
50+
- Unique 24-hexadecimal digit string that identifies the alert configuration.
5151
* - --envelope
5252
- envelope
5353
- false
@@ -73,7 +73,7 @@ Options
7373
* - --pretty
7474
-
7575
- false
76-
- Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
76+
- Flag that indicates whether the response body should be in the prettyprint format.
7777
* - --version
7878
- string
7979
- false
@@ -102,7 +102,7 @@ Run the command below.
102102

103103
.. code-block::
104104

105-
atlas api alertConfigurations deleteAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false
105+
atlas api alertConfigurations deleteAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8
106106

107107
.. Code end marker, please don't delete this comment
108108

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ atlas api alertConfigurations getAlertConfiguration
1414

1515
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the specified alert configuration from the specified project.
1616

17-
To use this resource, the requesting API Key must have the Project Read Only role.
17+
To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alert Configurations for One Project endpoint to retrieve all alert configurations to which the authenticated user has access.
1818

1919

2020
This resource remains under revision and may change.
@@ -47,7 +47,7 @@ Options
4747
* - --alertConfigId
4848
- string
4949
- true
50-
- Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.
50+
- Unique 24-hexadecimal digit string that identifies the alert configuration.
5151
* - --envelope
5252
- envelope
5353
- false
@@ -73,7 +73,7 @@ Options
7373
* - --pretty
7474
-
7575
- false
76-
- Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
76+
- Flag that indicates whether the response body should be in the prettyprint format.
7777
* - --version
7878
- string
7979
- false
@@ -102,7 +102,7 @@ Run the command below.
102102

103103
.. code-block::
104104

105-
atlas api alertConfigurations getAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false
105+
atlas api alertConfigurations getAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8
106106

107107
.. Code end marker, please don't delete this comment
108108

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

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Options
6060
* - --pretty
6161
-
6262
- false
63-
- Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
63+
- Flag that indicates whether the response body should be in the prettyprint format.
6464
* - --version
6565
- string
6666
- false
@@ -82,14 +82,3 @@ Inherited Options
8282
- false
8383
- 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.
8484

85-
Examples
86-
-----------------
87-
88-
Run the command below.
89-
90-
.. code-block::
91-
92-
atlas api alertConfigurations listAlertConfigurationMatchersFieldNames --version 2023-01-01 --envelope false --pretty false
93-
94-
.. Code end marker, please don't delete this comment
95-

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ atlas api alertConfigurations listAlertConfigurations
1414

1515
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alert configurations for one project.
1616

17-
These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role.
17+
These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.
1818

1919

2020
This resource remains under revision and may change.
@@ -81,7 +81,7 @@ Options
8181
* - --pretty
8282
-
8383
- false
84-
- Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
84+
- Flag that indicates whether the response body should be in the prettyprint format.
8585
* - --version
8686
- string
8787
- false
@@ -110,7 +110,7 @@ Run the command below.
110110

111111
.. code-block::
112112

113-
atlas api alertConfigurations listAlertConfigurations --version 2023-01-01 --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false
113+
atlas api alertConfigurations listAlertConfigurations --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8
114114

115115
.. Code end marker, please don't delete this comment
116116

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId
1414

1515
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alert configurations set for the specified alert.
1616

17-
To use this resource, the requesting API Key must have the Project Read Only role.
17+
To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access.
1818

1919

2020
This resource remains under revision and may change.
@@ -47,7 +47,7 @@ Options
4747
* - --alertId
4848
- string
4949
- true
50-
- Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.
50+
- Unique 24-hexadecimal digit string that identifies the alert.
5151
* - --envelope
5252
- envelope
5353
- false
@@ -85,7 +85,7 @@ Options
8585
* - --pretty
8686
-
8787
- false
88-
- Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
88+
- Flag that indicates whether the response body should be in the prettyprint format.
8989
* - --version
9090
- string
9191
- false
@@ -114,7 +114,7 @@ Run the command below.
114114

115115
.. code-block::
116116

117-
atlas api alertConfigurations listAlertConfigurationsByAlertId --version 2023-01-01 --alertId [alertId] --envelope false --groupId 32b6e34b3d91647abb20e7b8 --includeCount true --itemsPerPage 100 --pageNum 1 --pretty false
117+
atlas api alertConfigurations listAlertConfigurationsByAlertId --version 2023-01-01 --alertId [alertId] --groupId 32b6e34b3d91647abb20e7b8
118118

119119
.. Code end marker, please don't delete this comment
120120

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ atlas api alertConfigurations toggleAlertConfiguration
1414

1515
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Enables or disables the specified alert configuration in the specified project.
1616

17-
The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
17+
The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role.
1818

1919

2020
NOTE: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see Update One Alert Configuration.
@@ -50,7 +50,7 @@ Options
5050
* - --alertConfigId
5151
- string
5252
- true
53-
- Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.
53+
- Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert.
5454
* - --envelope
5555
- envelope
5656
- false
@@ -80,7 +80,7 @@ Options
8080
* - --pretty
8181
-
8282
- false
83-
- Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
83+
- Flag that indicates whether the response body should be in the prettyprint format.
8484
* - --version
8585
- string
8686
- false

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ atlas api alertConfigurations updateAlertConfiguration
1414

1515
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Updates one alert configuration in the specified project.
1616

17-
Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
17+
Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role.
1818

1919

2020
NOTE: To enable or disable the alert configuration, see Toggle One State of One Alert Configuration in One Project.
@@ -50,7 +50,7 @@ Options
5050
* - --alertConfigId
5151
- string
5252
- true
53-
- Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.
53+
- Unique 24-hexadecimal digit string that identifies the alert configuration.
5454
* - --envelope
5555
- envelope
5656
- false
@@ -80,7 +80,7 @@ Options
8080
* - --pretty
8181
-
8282
- false
83-
- Flag that indicates whether the response body should be in the <a href="https://en.wikipedia.org/wiki/Prettyprint" target="_blank" rel="noopener noreferrer">prettyprint</a> format.
83+
- Flag that indicates whether the response body should be in the prettyprint format.
8484
* - --version
8585
- string
8686
- false

0 commit comments

Comments
 (0)