Skip to content

Conversation

apix-bot[bot]
Copy link
Contributor

@apix-bot apix-bot bot commented Oct 7, 2025

Proposed changes

Update Autogenerated Commands
Jira ticket: CLOUDP-349927

Note: Jira ticket will be closed automatically when this PR is merged.

@apix-bot apix-bot bot requested review from a team as code owners October 7, 2025 08:42
@apix-bot apix-bot bot added auto_close_jira Closes Jira tickets automatically dependencies Pull requests that update a dependency file go Pull requests that update Go code labels Oct 7, 2025
@apix-bot apix-bot bot enabled auto-merge (squash) October 7, 2025 08:42
@github-actions github-actions bot added need-doc-review Improvements or additions to documentation, will be reviewed by the docs team atlascli labels Oct 7, 2025
Copy link
Contributor

github-actions bot commented Oct 7, 2025

APIx Bot :bowtie:: a message has been sent to Docs Slack channel 🚀.

},
{
Name: `Sandbox`,
Description: `Returns, adds, edits, and removes sandbox templates. Also enables/disables sandbox for an organization.`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Description: `Returns, adds, edits, and removes sandbox templates. Also enables/disables sandbox for an organization.`,
Description: `Returns, adds, edits, and removes sandbox templates. Also enables or disables sandbox for an organization.`,

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this cannot be changed as it's inherited from the OpenAPI specifications

QueryParameters: []shared_api.Parameter{
{
Name: `envelope`,
Description: `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.`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Description: `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.`,
Description: `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 to 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.`,

QueryParameters: []shared_api.Parameter{
{
Name: `envelope`,
Description: `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.`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Description: `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.`,
Description: `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 to 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.`,

URLParameters: []shared_api.Parameter{
{
Name: `orgId`,
Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`,
Description: `Unique 24-hexadecimal digit string that identifies the organization that contains the projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`,

OR

Suggested change
Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`,
Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which you have access.`,

URLParameters: []shared_api.Parameter{
{
Name: `orgId`,
Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`,
Description: `Unique 24-hexadecimal digit string that identifies the organization that contains the projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`,

OR

Suggested change
Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access.`,
Description: `Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which you have access.`,

* - -o, --output
- string
- false
- preferred api format, can be ["json", go-template] This value defaults to "json".
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- preferred api format, can be ["json", go-template] This value defaults to "json".
- Preferred api format. Value can be ["json", go-template]. If omitted, defaults to "json".

* - --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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 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)
- 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).

* - --pretty
-
- false
- flag that indicates whether the response body should be in the prettyprint format
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- flag that indicates whether the response body should be in the prettyprint format
- Flag that indicates whether the response body should be in the prettyprint format.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updating this one since it's our own flag

* - --sandboxConfigId
- string
- true
- unique 24-hexadecimal digit string that identifies the sandbox configuration
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- unique 24-hexadecimal digit string that identifies the sandbox configuration
- Unique 24-hexadecimal digit string that identifies the sandbox configuration.

@apix-bot apix-bot bot merged commit bd0b4e5 into master Oct 8, 2025
44 checks passed
@apix-bot apix-bot bot deleted the CLOUDP-349927 branch October 8, 2025 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
atlascli auto_close_jira Closes Jira tickets automatically dependencies Pull requests that update a dependency file go Pull requests that update Go code need-doc-review Improvements or additions to documentation, will be reviewed by the docs team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants