CLOUDP-328642: Update Autogenerated Commands #4019
Conversation
![apix-bot[bot]](https://avatars.githubusercontent.com/u/124201131?s=60&v=4){kind=small}
apix-bot
bot
added
auto_close_jira
github-actions
bot
added
need-doc-review
|
APIx Bot |
: a message has been sent to Docs Slack channel 🚀.
|
|
||
| `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. | ||
|
|
||
| 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). |
There was a problem hiding this comment.
| 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). | |
| 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). |
I think we should consider monospacing this, since it's referring specifically to a command.
| * - --envelope | ||
| - envelope | ||
| - false | ||
| - 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. |
There was a problem hiding this comment.
| - 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. | |
| - 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. |
Is there a specific reason Application is capitalized in the first instance despite not being the lead word of the sentence?
There was a problem hiding this comment.
Hi! Fixing Applicatoin, but on the second suggestion: we've seen issues with using in snooty. Are we sureenvelope=true`` is the right way or should it be envelope=true? (context #4024)
There was a problem hiding this comment.
I'll update the envelope too as I realized I was inverting the logic and trying to use ` instead of ``
| * - -o, --output | ||
| - string | ||
| - false | ||
| - preferred api format, can be ["json", go-template] This value defaults to "json". |
There was a problem hiding this comment.
| - preferred api format, can be ["json", go-template] This value defaults to "json". | |
| - Preferred API format, can be ["json", go-template] This value defaults to "json". |
We need to be consistent about capitalization for the opening word. Throughout the CLI docs we have favored capitalizing these, so let's stick to that. As for api -> API, "api" should only be used if we're referencing some specific syntax that uses it in lowercase, otherwise it's an acronym and should be capitalized appropriately.
| * - --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.
| - 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 (e.g. gzip) and you do not pipe the command (e.g. atlas command > out.zip). |
Capitalization, punctuation. Favor active voice.
| * - --version | ||
| - string | ||
| - false | ||
| - 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". |
There was a problem hiding this comment.
| - 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". | |
| - Version to use when calling the API, formatted as a "YYYY-MM-DD" date string. If you omit this flag, the API uses the version specified in your CLI profile in the ``api_version`` field. If you don't declare ``api_version``, this value defaults to "2023-01-01". |
One does not "call an API call". The bracketed options aside here also isn't very clear, so let's be more explicit about what it's meant to signal.
apix-bot
bot
force-pushed
the
CLOUDP-328642
branch
from
943e772 to
70e33ec
Compare
|
@lmkerbey-mdb, could you please approve this PR? |
apix-bot
bot
force-pushed
the
CLOUDP-328642
branch
from
70e33ec to
e0bf80a
Compare
|
Coverage Report 📈
|
Proposed changes
Update Autogenerated Commands
Jira ticket: CLOUDP-328642
Note: Jira ticket will be closed automatically when this PR is merged.