Skip to content

Commit 943e772

Browse files
committed
CLOUDP-328642: Update Autogenerated Commands
1 parent 39c8d67 commit 943e772

20 files changed

+855
-267
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via
1919

2020

2121

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

2424
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/Organizations/operation/getOrganizationSettings.
2525

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

@@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via
1919

2020

2121

22-
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/Resource-Policies/operation/createAtlasResourcePolicy.
22+
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/Resource-Policies/operation/createOrgResourcePolicy.
2323

2424
For more information and examples, see the referenced API documentation linked above.
2525

@@ -29,7 +29,7 @@ Syntax
2929
.. code-block::
3030
:caption: Command Syntax
3131

32-
atlas api resourcePolicies createAtlasResourcePolicy [options]
32+
atlas api resourcePolicies createOrgResourcePolicy [options]
3333

3434
.. Code end marker, please don't delete this comment
3535

@@ -55,7 +55,7 @@ Options
5555
* - -h, --help
5656
-
5757
- false
58-
- help for createAtlasResourcePolicy
58+
- help for createOrgResourcePolicy
5959
* - --orgId
6060
- string
6161
- true

docs/command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy.txt renamed to docs/command/atlas-api-resourcePolicies-deleteOrgResourcePolicy.txt

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

3-
====================================================
4-
atlas api resourcePolicies deleteAtlasResourcePolicy
5-
====================================================
3+
==================================================
4+
atlas api resourcePolicies deleteOrgResourcePolicy
5+
==================================================
66

77
.. default-domain:: mongodb
88

@@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via
1919

2020

2121

22-
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/Resource-Policies/operation/deleteAtlasResourcePolicy.
22+
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/Resource-Policies/operation/deleteOrgResourcePolicy.
2323

2424
For more information and examples, see the referenced API documentation linked above.
2525

@@ -29,7 +29,7 @@ Syntax
2929
.. code-block::
3030
:caption: Command Syntax
3131

32-
atlas api resourcePolicies deleteAtlasResourcePolicy [options]
32+
atlas api resourcePolicies deleteOrgResourcePolicy [options]
3333

3434
.. Code end marker, please don't delete this comment
3535

@@ -51,7 +51,7 @@ Options
5151
* - -h, --help
5252
-
5353
- false
54-
- help for deleteAtlasResourcePolicy
54+
- help for deleteOrgResourcePolicy
5555
* - --orgId
5656
- string
5757
- true
@@ -96,5 +96,5 @@ Inherited Options
9696
Examples
9797
--------
9898

99-
.. literalinclude:: /includes/examples/atlas-api-resourcePolicies-deleteAtlasResourcePolicy-2024-08-05-default.sh
99+
.. literalinclude:: /includes/examples/atlas-api-resourcePolicies-deleteOrgResourcePolicy-2024-08-05-default.sh
100100
:language: shell

docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicy.txt renamed to docs/command/atlas-api-resourcePolicies-getOrgResourcePolicy.txt

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

3-
=================================================
4-
atlas api resourcePolicies getAtlasResourcePolicy
5-
=================================================
3+
===============================================
4+
atlas api resourcePolicies getOrgResourcePolicy
5+
===============================================
66

77
.. default-domain:: mongodb
88

@@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via
1919

2020

2121

22-
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/Resource-Policies/operation/getAtlasResourcePolicy.
22+
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/Resource-Policies/operation/getOrgResourcePolicy.
2323

2424
For more information and examples, see the referenced API documentation linked above.
2525

@@ -29,7 +29,7 @@ Syntax
2929
.. code-block::
3030
:caption: Command Syntax
3131

32-
atlas api resourcePolicies getAtlasResourcePolicy [options]
32+
atlas api resourcePolicies getOrgResourcePolicy [options]
3333

3434
.. Code end marker, please don't delete this comment
3535

@@ -51,7 +51,7 @@ Options
5151
* - -h, --help
5252
-
5353
- false
54-
- help for getAtlasResourcePolicy
54+
- help for getOrgResourcePolicy
5555
* - --orgId
5656
- string
5757
- true
@@ -96,5 +96,5 @@ Inherited Options
9696
Examples
9797
--------
9898

99-
.. literalinclude:: /includes/examples/atlas-api-resourcePolicies-getAtlasResourcePolicy-2024-08-05-default.sh
99+
.. literalinclude:: /includes/examples/atlas-api-resourcePolicies-getOrgResourcePolicy-2024-08-05-default.sh
100100
:language: shell

docs/command/atlas-api-resourcePolicies-getAtlasResourcePolicies.txt renamed to docs/command/atlas-api-resourcePolicies-listOrgResourcePolicies.txt

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

3-
===================================================
4-
atlas api resourcePolicies getAtlasResourcePolicies
5-
===================================================
3+
==================================================
4+
atlas api resourcePolicies listOrgResourcePolicies
5+
==================================================
66

77
.. default-domain:: mongodb
88

@@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via
1919

2020

2121

22-
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/Resource-Policies/operation/getAtlasResourcePolicies.
22+
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/Resource-Policies/operation/listOrgResourcePolicies.
2323

2424
For more information and examples, see the referenced API documentation linked above.
2525

@@ -29,7 +29,7 @@ Syntax
2929
.. code-block::
3030
:caption: Command Syntax
3131

32-
atlas api resourcePolicies getAtlasResourcePolicies [options]
32+
atlas api resourcePolicies listOrgResourcePolicies [options]
3333

3434
.. Code end marker, please don't delete this comment
3535

@@ -51,7 +51,7 @@ Options
5151
* - -h, --help
5252
-
5353
- false
54-
- help for getAtlasResourcePolicies
54+
- help for listOrgResourcePolicies
5555
* - --orgId
5656
- string
5757
- true
@@ -92,5 +92,5 @@ Inherited Options
9292
Examples
9393
--------
9494

95-
.. literalinclude:: /includes/examples/atlas-api-resourcePolicies-getAtlasResourcePolicies-2024-08-05-default.sh
95+
.. literalinclude:: /includes/examples/atlas-api-resourcePolicies-listOrgResourcePolicies-2024-08-05-default.sh
9696
:language: shell

docs/command/atlas-api-resourcePolicies-updateAtlasResourcePolicy.txt renamed to docs/command/atlas-api-resourcePolicies-updateOrgResourcePolicy.txt

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

3-
====================================================
4-
atlas api resourcePolicies updateAtlasResourcePolicy
5-
====================================================
3+
==================================================
4+
atlas api resourcePolicies updateOrgResourcePolicy
5+
==================================================
66

77
.. default-domain:: mongodb
88

@@ -19,7 +19,7 @@ Admin API capabilities have their own release lifecycle, which you can check via
1919

2020

2121

22-
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/Resource-Policies/operation/updateAtlasResourcePolicy.
22+
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/Resource-Policies/operation/updateOrgResourcePolicy.
2323

2424
For more information and examples, see the referenced API documentation linked above.
2525

@@ -29,7 +29,7 @@ Syntax
2929
.. code-block::
3030
:caption: Command Syntax
3131

32-
atlas api resourcePolicies updateAtlasResourcePolicy [options]
32+
atlas api resourcePolicies updateOrgResourcePolicy [options]
3333

3434
.. Code end marker, please don't delete this comment
3535

@@ -55,7 +55,7 @@ Options
5555
* - -h, --help
5656
-
5757
- false
58-
- help for updateAtlasResourcePolicy
58+
- help for updateOrgResourcePolicy
5959
* - --orgId
6060
- string
6161
- true

docs/command/atlas-api-resourcePolicies.txt

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,23 +56,23 @@ Inherited Options
5656
Related Commands
5757
----------------
5858

59-
* :ref:`atlas-api-resourcePolicies-createAtlasResourcePolicy` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Create one Atlas Resource Policy for an org.
60-
* :ref:`atlas-api-resourcePolicies-deleteAtlasResourcePolicy` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Delete one Atlas Resource Policy for an org.
61-
* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicies` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Return all Atlas Resource Policies for the org.
62-
* :ref:`atlas-api-resourcePolicies-getAtlasResourcePolicy` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Return one Atlas Resource Policy for an org.
59+
* :ref:`atlas-api-resourcePolicies-createOrgResourcePolicy` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Create one Atlas Resource Policy for an org.
60+
* :ref:`atlas-api-resourcePolicies-deleteOrgResourcePolicy` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Delete one Atlas Resource Policy for an org.
61+
* :ref:`atlas-api-resourcePolicies-getOrgResourcePolicy` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Return one Atlas Resource Policy for an org.
6362
* :ref:`atlas-api-resourcePolicies-getResourcesNonCompliant` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Return all non-compliant resources for an org.
64-
* :ref:`atlas-api-resourcePolicies-updateAtlasResourcePolicy` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Update one Atlas Resource Policy for an org.
63+
* :ref:`atlas-api-resourcePolicies-listOrgResourcePolicies` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Return all Atlas Resource Policies for the org.
64+
* :ref:`atlas-api-resourcePolicies-updateOrgResourcePolicy` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Update one Atlas Resource Policy for an org.
6565
* :ref:`atlas-api-resourcePolicies-validateAtlasResourcePolicy` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Validate one Atlas Resource Policy for an org.
6666

6767

6868
.. toctree::
6969
:titlesonly:
7070

71-
createAtlasResourcePolicy </command/atlas-api-resourcePolicies-createAtlasResourcePolicy>
72-
deleteAtlasResourcePolicy </command/atlas-api-resourcePolicies-deleteAtlasResourcePolicy>
73-
getAtlasResourcePolicies </command/atlas-api-resourcePolicies-getAtlasResourcePolicies>
74-
getAtlasResourcePolicy </command/atlas-api-resourcePolicies-getAtlasResourcePolicy>
71+
createOrgResourcePolicy </command/atlas-api-resourcePolicies-createOrgResourcePolicy>
72+
deleteOrgResourcePolicy </command/atlas-api-resourcePolicies-deleteOrgResourcePolicy>
73+
getOrgResourcePolicy </command/atlas-api-resourcePolicies-getOrgResourcePolicy>
7574
getResourcesNonCompliant </command/atlas-api-resourcePolicies-getResourcesNonCompliant>
76-
updateAtlasResourcePolicy </command/atlas-api-resourcePolicies-updateAtlasResourcePolicy>
75+
listOrgResourcePolicies </command/atlas-api-resourcePolicies-listOrgResourcePolicies>
76+
updateOrgResourcePolicy </command/atlas-api-resourcePolicies-updateOrgResourcePolicy>
7777
validateAtlasResourcePolicy </command/atlas-api-resourcePolicies-validateAtlasResourcePolicy>
7878

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
.. _atlas-api-teams-getProjectTeam:
2+
3+
==============================
4+
atlas api teams getProjectTeam
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 one team to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier.
16+
17+
Public Preview: 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+
All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Read Only role.
23+
24+
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/Teams/operation/getProjectTeam.
25+
26+
For more information and examples, see the referenced API documentation linked above.
27+
28+
Syntax
29+
------
30+
31+
.. code-block::
32+
:caption: Command Syntax
33+
34+
atlas api teams getProjectTeam [options]
35+
36+
.. Code end marker, please don't delete this comment
37+
38+
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+
* - --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 getProjectTeam
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+
* - --teamId
76+
- string
77+
- true
78+
- Unique 24-hexadecimal digit string that identifies the team for which you want to get.
79+
* - --version
80+
- string
81+
- false
82+
- api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".
83+
84+
Inherited Options
85+
-----------------
86+
87+
.. list-table::
88+
:header-rows: 1
89+
:widths: 20 10 10 60
90+
91+
* - Name
92+
- Type
93+
- Required
94+
- Description
95+
* - -P, --profile
96+
- string
97+
- false
98+
- 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.
99+
100+
Examples
101+
--------
102+
103+
.. literalinclude:: /includes/examples/atlas-api-teams-getProjectTeam-2023-01-01-default.sh
104+
:language: shell

docs/command/atlas-api-teams.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ Related Commands
6060
* :ref:`atlas-api-teams-addTeamUser` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Adds one or more MongoDB Cloud users from the specified organization to the specified team.
6161
* :ref:`atlas-api-teams-createTeam` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Creates one team in the specified organization.
6262
* :ref:`atlas-api-teams-deleteTeam` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier.
63+
* :ref:`atlas-api-teams-getProjectTeam` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns one team to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier.
6364
* :ref:`atlas-api-teams-getTeamById` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns one team that you identified using its unique 24-hexadecimal digit ID.
6465
* :ref:`atlas-api-teams-getTeamByName` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns one team that you identified using its human-readable name.
6566
* :ref:`atlas-api-teams-listOrganizationTeams` - `Public Preview: please provide feedback <https://feedback.mongodb.com/forums/930808-atlas-cli>`_: Returns all teams that belong to the specified organization.
@@ -77,6 +78,7 @@ Related Commands
7778
addTeamUser </command/atlas-api-teams-addTeamUser>
7879
createTeam </command/atlas-api-teams-createTeam>
7980
deleteTeam </command/atlas-api-teams-deleteTeam>
81+
getProjectTeam </command/atlas-api-teams-getProjectTeam>
8082
getTeamById </command/atlas-api-teams-getTeamById>
8183
getTeamByName </command/atlas-api-teams-getTeamByName>
8284
listOrganizationTeams </command/atlas-api-teams-listOrganizationTeams>

docs/command/includes/atlas-api-resourcePolicies-deleteAtlasResourcePolicy-2024-08-05-default.sh

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)