Skip to content

Commit 460028d

Browse files
authored
CLOUDP-311856: Fix docs errors (#3818)
1 parent b90fc3e commit 460028d

File tree

503 files changed

+5035
-1023
lines changed

Some content is hidden

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

503 files changed

+5035
-1023
lines changed

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api accessTracking listAccessLogsByClusterName
1212
:depth: 1
1313
:class: singlecol
1414

15-
`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.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Returns the access logs of one cluster identified by the cluster's name.
1620

1721
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.
1822

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api accessTracking listAccessLogsByHostname
1212
:depth: 1
1313
:class: singlecol
1414

15-
`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.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Returns the access logs of one cluster identified by the cluster's hostname.
1620

1721
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.
1822

docs/command/atlas-api-accessTracking.txt

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api accessTracking
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns access logs for authentication attempts made to Atlas database deployments.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Returns access logs for authentication attempts made to Atlas database deployments.
1620

1721
To view database access history, you must have either the Project Owner or Organization Owner role.
1822

@@ -51,8 +55,16 @@ Inherited Options
5155
Related Commands
5256
----------------
5357

54-
* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - `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.
55-
* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - `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.
58+
* :ref:`atlas-api-accessTracking-listAccessLogsByClusterName` - .. blockquote::
59+
60+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
61+
62+
Returns the access logs of one cluster identified by the cluster's name.
63+
* :ref:`atlas-api-accessTracking-listAccessLogsByHostname` - .. blockquote::
64+
65+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
66+
67+
Returns the access logs of one cluster identified by the cluster's hostname.
5668

5769

5870
.. toctree::

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api alertConfigurations createAlertConfiguration
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one alert configuration for the specified project.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Creates one alert configuration for the specified project.
1620

1721
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.
1822

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api alertConfigurations deleteAlertConfiguration
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Removes one alert configuration from the specified project.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Removes one alert configuration from the specified project.
1620

1721
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.
1822

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api alertConfigurations getAlertConfiguration
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the specified alert configuration from the specified project.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Returns the specified alert configuration from the specified project.
1620

1721
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.
1822

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api alertConfigurations listAlertConfigurationMatchersFieldNames
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.
1620

1721
You can successfully call this endpoint with any assigned role.
1822

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api alertConfigurations listAlertConfigurations
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alert configurations for one project.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Returns all alert configurations for one project.
1620

1721
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.
1822

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api alertConfigurations listAlertConfigurationsByAlertId
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alert configurations set for the specified alert.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Returns all alert configurations set for the specified alert.
1620

1721
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.
1822

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api alertConfigurations toggleAlertConfiguration
1212
:depth: 1
1313
:class: singlecol
1414

15-
`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.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Enables or disables the specified alert configuration in the specified project.
1620

1721
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.
1822

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api alertConfigurations updateAlertConfiguration
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Updates one alert configuration in the specified project.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Updates one alert configuration in the specified project.
1620

1721
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.
1822

docs/command/atlas-api-alertConfigurations.txt

Lines changed: 45 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api alertConfigurations
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users.
1620

1721
This collection remains under revision and may change.
1822

@@ -51,14 +55,46 @@ Inherited Options
5155
Related Commands
5256
----------------
5357

54-
* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one alert configuration for the specified project.
55-
* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Removes one alert configuration from the specified project.
56-
* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the specified alert configuration from the specified project.
57-
* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.
58-
* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alert configurations for one project.
59-
* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alert configurations set for the specified alert.
60-
* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - `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.
61-
* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Updates one alert configuration in the specified project.
58+
* :ref:`atlas-api-alertConfigurations-createAlertConfiguration` - .. blockquote::
59+
60+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
61+
62+
Creates one alert configuration for the specified project.
63+
* :ref:`atlas-api-alertConfigurations-deleteAlertConfiguration` - .. blockquote::
64+
65+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
66+
67+
Removes one alert configuration from the specified project.
68+
* :ref:`atlas-api-alertConfigurations-getAlertConfiguration` - .. blockquote::
69+
70+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
71+
72+
Returns the specified alert configuration from the specified project.
73+
* :ref:`atlas-api-alertConfigurations-listAlertConfigurationMatchersFieldNames` - .. blockquote::
74+
75+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
76+
77+
Get all field names that the matchers.fieldName parameter accepts when you create or update an Alert Configuration.
78+
* :ref:`atlas-api-alertConfigurations-listAlertConfigurations` - .. blockquote::
79+
80+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
81+
82+
Returns all alert configurations for one project.
83+
* :ref:`atlas-api-alertConfigurations-listAlertConfigurationsByAlertId` - .. blockquote::
84+
85+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
86+
87+
Returns all alert configurations set for the specified alert.
88+
* :ref:`atlas-api-alertConfigurations-toggleAlertConfiguration` - .. blockquote::
89+
90+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
91+
92+
Enables or disables the specified alert configuration in the specified project.
93+
* :ref:`atlas-api-alertConfigurations-updateAlertConfiguration` - .. blockquote::
94+
95+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
96+
97+
Updates one alert configuration in the specified project.
6298

6399

64100
.. toctree::

docs/command/atlas-api-alerts-acknowledgeAlert.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api alerts acknowledgeAlert
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Confirms receipt of one existing alert.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Confirms receipt of one existing alert.
1620

1721
This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. Use the Return All Alerts from One Project endpoint to retrieve all alerts to which the authenticated user has access.
1822

docs/command/atlas-api-alerts-getAlert.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api alerts getAlert
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns one alert.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Returns one alert.
1620

1721
This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. 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.
1822

docs/command/atlas-api-alerts-listAlerts.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api alerts listAlerts
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alerts.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Returns all alerts.
1620

1721
These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.
1822

docs/command/atlas-api-alerts-listAlertsByAlertConfigurationId.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api alerts listAlertsByAlertConfigurationId
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all open alerts that the specified alert configuration triggers.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Returns all open alerts that the specified alert configuration triggers.
1620

1721
These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. 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.
1822

docs/command/atlas-api-alerts.txt

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api alerts
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define.
1620

1721
This collection remains under revision and may change.
1822

@@ -51,10 +55,26 @@ Inherited Options
5155
Related Commands
5256
----------------
5357

54-
* :ref:`atlas-api-alerts-acknowledgeAlert` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Confirms receipt of one existing alert.
55-
* :ref:`atlas-api-alerts-getAlert` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns one alert.
56-
* :ref:`atlas-api-alerts-listAlerts` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all alerts.
57-
* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - `Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all open alerts that the specified alert configuration triggers.
58+
* :ref:`atlas-api-alerts-acknowledgeAlert` - .. blockquote::
59+
60+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
61+
62+
Confirms receipt of one existing alert.
63+
* :ref:`atlas-api-alerts-getAlert` - .. blockquote::
64+
65+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
66+
67+
Returns one alert.
68+
* :ref:`atlas-api-alerts-listAlerts` - .. blockquote::
69+
70+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
71+
72+
Returns all alerts.
73+
* :ref:`atlas-api-alerts-listAlertsByAlertConfigurationId` - .. blockquote::
74+
75+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
76+
77+
Returns all open alerts that the specified alert configuration triggers.
5878

5979

6080
.. toctree::

docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api atlasSearch createAtlasSearchDeployment
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates Search Nodes for the specified cluster.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Creates Search Nodes for the specified cluster.
1620

1721
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/Atlas-Search/operation/createAtlasSearchDeployment.
1822

docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ atlas api atlasSearch createAtlasSearchIndex
1212
:depth: 1
1313
:class: singlecol
1414

15-
`Public Preview: please provide feedback at <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one Atlas Search index on the specified collection.
15+
.. blockquote::
16+
17+
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
18+
19+
Creates one Atlas Search index on the specified collection.
1620

1721
Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role.
1822

0 commit comments

Comments
 (0)