CLOUDP-349927: Update Autogenerated Commands #4249
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,93 @@ | ||||||
| .. _atlas-api-sandbox-generateSandboxClusterDescription: | ||||||
|
|
||||||
| =================================================== | ||||||
| atlas api sandbox generateSandboxClusterDescription | ||||||
| =================================================== | ||||||
|
|
||||||
| .. default-domain:: mongodb | ||||||
|
|
||||||
| .. contents:: On this page | ||||||
| :local: | ||||||
| :backlinks: none | ||||||
| :depth: 1 | ||||||
| :class: singlecol | ||||||
|
|
||||||
| Return cluster description from sandbox template configuration. | ||||||
|
|
||||||
| The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. | ||||||
| Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. | ||||||
|
|
||||||
| 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-generategroupsandboxclusterdescription. | ||||||
|
|
||||||
| For more information and examples, see the referenced API documentation linked above. | ||||||
|
|
||||||
| Syntax | ||||||
| ------ | ||||||
|
|
||||||
| .. code-block:: | ||||||
| :caption: Command Syntax | ||||||
|
|
||||||
| atlas api sandbox generateSandboxClusterDescription [options] | ||||||
|
|
||||||
| .. Code end marker, please don't delete this comment | ||||||
|
|
||||||
| Options | ||||||
| ------- | ||||||
|
|
||||||
| .. list-table:: | ||||||
| :header-rows: 1 | ||||||
| :widths: 20 10 10 60 | ||||||
|
|
||||||
| * - Name | ||||||
| - Type | ||||||
| - Required | ||||||
| - Description | ||||||
| * - --envelope | ||||||
| - | ||||||
| - false | ||||||
| - flag that indicates whether Application wraps the response in an envelope JSON object | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| * - --groupId | ||||||
| - string | ||||||
| - true | ||||||
| - unique 24-hexadecimal digit string that identifies your project | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| * - -h, --help | ||||||
| - | ||||||
| - false | ||||||
| - help for generateSandboxClusterDescription | ||||||
| * - -o, --output | ||||||
| - string | ||||||
| - false | ||||||
| - preferred api format, can be ["json", go-template] This value defaults to "json". | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| * - --outputFile | ||||||
| - string | ||||||
| - false | ||||||
| - 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) | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| * - --pretty | ||||||
| - | ||||||
| - false | ||||||
| - flag that indicates whether the response body should be in the prettyprint format | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. updating this one since it's our own flag |
||||||
| * - --sandboxConfigId | ||||||
| - string | ||||||
| - true | ||||||
| - unique 24-hexadecimal digit string that identifies the sandbox configuration | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| * - --version | ||||||
| - string | ||||||
| - false | ||||||
| - api version to use when calling the api call [options: "preview"], defaults to the latest version or the profiles api_version config value if set This value defaults to "preview". | ||||||
blva marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| Inherited Options | ||||||
| ----------------- | ||||||
|
|
||||||
| .. list-table:: | ||||||
| :header-rows: 1 | ||||||
| :widths: 20 10 10 60 | ||||||
|
|
||||||
| * - Name | ||||||
| - Type | ||||||
| - Required | ||||||
| - Description | ||||||
| * - -P, --profile | ||||||
| - string | ||||||
| - false | ||||||
| - 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. | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,64 @@ | ||||||
| .. _atlas-api-sandbox: | ||||||
|
|
||||||
| ================= | ||||||
| atlas api sandbox | ||||||
| ================= | ||||||
|
|
||||||
| .. default-domain:: mongodb | ||||||
|
|
||||||
| .. contents:: On this page | ||||||
| :local: | ||||||
| :backlinks: none | ||||||
| :depth: 1 | ||||||
| :class: singlecol | ||||||
|
|
||||||
| Returns, adds, edits, and removes sandbox templates. | ||||||
|
|
||||||
| The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. | ||||||
| Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| Also enables/disables sandbox for an organization. | ||||||
|
|
||||||
| Options | ||||||
| ------- | ||||||
|
|
||||||
| .. list-table:: | ||||||
| :header-rows: 1 | ||||||
| :widths: 20 10 10 60 | ||||||
|
|
||||||
| * - Name | ||||||
| - Type | ||||||
| - Required | ||||||
| - Description | ||||||
| * - -h, --help | ||||||
| - | ||||||
| - false | ||||||
| - help for sandbox | ||||||
|
|
||||||
| Inherited Options | ||||||
| ----------------- | ||||||
|
|
||||||
| .. list-table:: | ||||||
| :header-rows: 1 | ||||||
| :widths: 20 10 10 60 | ||||||
|
|
||||||
| * - Name | ||||||
| - Type | ||||||
| - Required | ||||||
| - Description | ||||||
| * - -P, --profile | ||||||
| - string | ||||||
| - false | ||||||
| - 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. | ||||||
|
|
||||||
| Related Commands | ||||||
| ---------------- | ||||||
|
|
||||||
| * :ref:`atlas-api-sandbox-generateSandboxClusterDescription` - Return cluster description from sandbox template configuration. | ||||||
|
|
||||||
|
|
||||||
| .. toctree:: | ||||||
| :titlesonly: | ||||||
|
|
||||||
| generateSandboxClusterDescription </command/atlas-api-sandbox-generateSandboxClusterDescription> | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| deleteOrgSandboxConfig --version preview --orgId 4888442a3354817a7320eb61 --sandboxConfigId 507f1f77bcf86cd799439011 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| getOrgSandboxConfig --version preview --orgId 4888442a3354817a7320eb61 --sandboxConfigId 507f1f77bcf86cd799439011 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| listOrgSandboxConfig --version preview --orgId 4888442a3354817a7320eb61 |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated