Skip to content

Commit d01f0e9

Browse files
apix-bot[bot]apix-bot[bot]
authored
CLOUDP-332912: Update Autogenerated Commands (#4048)
Co-authored-by: apix-bot[bot] <168195273+apix-bot[bot]@users.noreply.github.com>
1 parent 6c892a7 commit d01f0e9

26 files changed

+2520
-321
lines changed

‎docs/command/atlas-api-organizations-getOrganizationSettings.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ atlas api organizations getOrganizationSettings
1717
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
1818
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
1919

20-
To use this resource, the requesting Service Account or API Key must have the Organization Owner role.
20+
To use this resource, the requesting Service Account or API Key must have the Organization Member role.
2121

2222
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getorganizationsettings.
2323

‎docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails.txt

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
.. _atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails:
2+
3+
====================================================================
4+
atlas api queryShapeInsights getGroupClusterQueryShapeInsightDetails
5+
====================================================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the metadata and statistics summary for a given query shape hash.
16+
17+
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterqueryshapeinsightdetails.
21+
22+
For more information and examples, see the referenced API documentation linked above.
23+
24+
Syntax
25+
------
26+
27+
.. code-block::
28+
:caption: Command Syntax
29+
30+
atlas api queryShapeInsights getGroupClusterQueryShapeInsightDetails [options]
31+
32+
.. Code end marker, please don't delete this comment
33+
34+
Options
35+
-------
36+
37+
.. list-table::
38+
:header-rows: 1
39+
:widths: 20 10 10 60
40+
41+
* - Name
42+
- Type
43+
- Required
44+
- Description
45+
* - --clusterName
46+
- string
47+
- true
48+
- Human-readable label that identifies the cluster.
49+
* - --envelope
50+
- envelope
51+
- false
52+
- 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.
53+
* - --groupId
54+
- string
55+
- true
56+
- 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.
57+
58+
**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.
59+
* - -h, --help
60+
-
61+
- false
62+
- help for getGroupClusterQueryShapeInsightDetails
63+
* - -o, --output
64+
- string
65+
- false
66+
- preferred api format, can be ["json", go-template] This value defaults to "json".
67+
* - --outputFile
68+
- string
69+
- false
70+
- file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
71+
* - --pretty
72+
-
73+
- false
74+
- Flag that indicates whether the response body should be in the prettyprint format.
75+
* - --processIds
76+
- mongod
77+
- false
78+
- ProcessIds from which to retrieve query shape statistics. A processId is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (mongod or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. To include multiple processIds, pass the parameter multiple times delimited with an ampersand (`&`) between each processId.
79+
* - --queryShapeHash
80+
- string
81+
- true
82+
- A SHA256 hash of a query shape, output by MongoDB commands like $queryStats and $explain or slow query logs.
83+
* - --since
84+
- int
85+
- false
86+
- Date and time from which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).
87+
88+
- If you don't specify the **until** parameter, the endpoint returns data covering from the **since** value and the current time.
89+
- If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.
90+
* - --until
91+
- int
92+
- false
93+
- Date and time up until which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).
94+
95+
- If you specify the **until** parameter, you must specify the **since** parameter.
96+
- If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.
97+
* - --version
98+
- string
99+
- false
100+
- api version to use when calling the api call [options: "2025-03-12"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-03-12".
101+
102+
Inherited Options
103+
-----------------
104+
105+
.. list-table::
106+
:header-rows: 1
107+
:widths: 20 10 10 60
108+
109+
* - Name
110+
- Type
111+
- Required
112+
- Description
113+
* - -P, --profile
114+
- string
115+
- false
116+
- 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.
117+
118+
Examples
119+
--------
120+
121+
.. literalinclude:: /includes/examples/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails-2025-03-12-default.sh
122+
:language: shell

‎docs/command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries.txt

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
.. _atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries:
2+
3+
======================================================================
4+
atlas api queryShapeInsights getGroupClusterQueryShapeInsightSummaries
5+
======================================================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns a list of query shape statistics summaries for a given cluster.
16+
17+
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
Query shape statistics provide performance insights about MongoDB queries, helping users identify problematic query patterns and potential optimizations.
21+
22+
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupclusterqueryshapeinsightsummaries.
23+
24+
For more information and examples, see the referenced API documentation linked above.
25+
26+
Syntax
27+
------
28+
29+
.. code-block::
30+
:caption: Command Syntax
31+
32+
atlas api queryShapeInsights getGroupClusterQueryShapeInsightSummaries [options]
33+
34+
.. Code end marker, please don't delete this comment
35+
36+
Options
37+
-------
38+
39+
.. list-table::
40+
:header-rows: 1
41+
:widths: 20 10 10 60
42+
43+
* - Name
44+
- Type
45+
- Required
46+
- Description
47+
* - --clusterName
48+
- string
49+
- true
50+
- Human-readable label that identifies the cluster.
51+
* - --commands
52+
- &
53+
- false
54+
- Retrieve query shape statistics matching specified MongoDB commands. To include multiple commands, pass the parameter multiple times delimited with an ampersand (&) between each command. The currently supported parameters are find, distinct, and aggregate. Omit this parameter to return results for all supported commands.
55+
* - --envelope
56+
- envelope
57+
- false
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.
59+
* - --groupId
60+
- string
61+
- true
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.
65+
* - -h, --help
66+
-
67+
- false
68+
- help for getGroupClusterQueryShapeInsightSummaries
69+
* - --nSummaries
70+
- int
71+
- false
72+
- Maximum number of query statistic summaries to return.
73+
* - --namespaces
74+
- .
75+
- false
76+
- Namespaces from which to retrieve query shape statistics. A namespace consists of one database and one collection resource written as .: ``<database>.<collection>``. To include multiple namespaces, pass the parameter multiple times delimited with an ampersand (`&`) between each namespace. Omit this parameter to return results for all namespaces.
77+
* - -o, --output
78+
- string
79+
- false
80+
- preferred api format, can be ["json", go-template] This value defaults to "json".
81+
* - --outputFile
82+
- string
83+
- false
84+
- file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
85+
* - --pretty
86+
-
87+
- false
88+
- Flag that indicates whether the response body should be in the prettyprint format.
89+
* - --processIds
90+
- mongod
91+
- false
92+
- ProcessIds from which to retrieve query shape statistics. A processId is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (mongod or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. To include multiple processIds, pass the parameter multiple times delimited with an ampersand (`&`) between each processId.
93+
* - --queryShapeHashes
94+
- &
95+
- false
96+
- A list of SHA256 hashes of desired query shapes, output by MongoDB commands like $queryStats and $explain or slow query logs. To include multiple series, pass the parameter multiple times delimited with an ampersand (&) between each series. Omit this parameter to return results for all available series.
97+
* - --series
98+
- &
99+
- false
100+
- Query shape statistics data series to retrieve. A series represents a specific metric about query execution. To include multiple series, pass the parameter multiple times delimited with an ampersand (&) between each series. Omit this parameter to return results for all available series.
101+
* - --since
102+
- int
103+
- false
104+
- Date and time from which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).
105+
106+
- If you don't specify the **until** parameter, the endpoint returns data covering from the **since** value and the current time.
107+
- If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.
108+
* - --until
109+
- int
110+
- false
111+
- Date and time up until which to retrieve query shape statistics. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).
112+
113+
- If you specify the **until** parameter, you must specify the **since** parameter.
114+
- If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.
115+
* - --version
116+
- string
117+
- false
118+
- api version to use when calling the api call [options: "2025-03-12"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2025-03-12".
119+
120+
Inherited Options
121+
-----------------
122+
123+
.. list-table::
124+
:header-rows: 1
125+
:widths: 20 10 10 60
126+
127+
* - Name
128+
- Type
129+
- Required
130+
- Description
131+
* - -P, --profile
132+
- string
133+
- false
134+
- 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.
135+
136+
Examples
137+
--------
138+
139+
.. literalinclude:: /includes/examples/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries-2025-03-12-default.sh
140+
:language: shell

‎docs/command/atlas-api-queryShapeInsights.txt

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
.. _atlas-api-queryShapeInsights:
2+
3+
============================
4+
atlas api queryShapeInsights
5+
============================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
`Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_:
16+
17+
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
18+
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
19+
20+
21+
22+
Options
23+
-------
24+
25+
.. list-table::
26+
:header-rows: 1
27+
:widths: 20 10 10 60
28+
29+
* - Name
30+
- Type
31+
- Required
32+
- Description
33+
* - -h, --help
34+
-
35+
- false
36+
- help for queryShapeInsights
37+
38+
Inherited Options
39+
-----------------
40+
41+
.. list-table::
42+
:header-rows: 1
43+
:widths: 20 10 10 60
44+
45+
* - Name
46+
- Type
47+
- Required
48+
- Description
49+
* - -P, --profile
50+
- string
51+
- false
52+
- 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.
53+
54+
Related Commands
55+
----------------
56+
57+
* :ref:`atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns the metadata and statistics summary for a given query shape hash.
58+
* :ref:`atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns a list of query shape statistics summaries for a given cluster.
59+
60+
61+
.. toctree::
62+
:titlesonly:
63+
64+
getGroupClusterQueryShapeInsightDetails </command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightDetails>
65+
getGroupClusterQueryShapeInsightSummaries </command/atlas-api-queryShapeInsights-getGroupClusterQueryShapeInsightSummaries>
66+

‎docs/command/atlas-api-resourcePolicies-createAtlasResourcePolicy.txt renamed to ‎docs/command/atlas-api-resourcePolicies-createOrgResourcePolicy.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
.. _atlas-api-resourcePolicies-createAtlasResourcePolicy:
1+
.. _atlas-api-resourcePolicies-createOrgResourcePolicy:
22

3-
====================================================
4-
atlas api resourcePolicies createAtlasResourcePolicy
5-
====================================================
3+
==================================================
4+
atlas api resourcePolicies createOrgResourcePolicy
5+
==================================================
66

77
.. default-domain:: mongodb
88

@@ -17,7 +17,7 @@ atlas api resourcePolicies createAtlasResourcePolicy
1717
The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli).
1818
Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
1919

20-
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createatlasresourcepolicy.
20+
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createorgresourcepolicy.
2121

2222
For more information and examples, see the referenced API documentation linked above.
2323

@@ -27,7 +27,7 @@ Syntax
2727
.. code-block::
2828
:caption: Command Syntax
2929

30-
atlas api resourcePolicies createAtlasResourcePolicy [options]
30+
atlas api resourcePolicies createOrgResourcePolicy [options]
3131

3232
.. Code end marker, please don't delete this comment
3333

@@ -53,7 +53,7 @@ Options
5353
* - -h, --help
5454
-
5555
- false
56-
- help for createAtlasResourcePolicy
56+
- help for createOrgResourcePolicy
5757
* - --orgId
5858
- string
5959
- true

0 commit comments

Comments
 (0)