(DOCSP-47322) [CLI] Update --role flag description to link to API docs and User Roles page #3689

elyse-mdb · 2025-02-25T20:48:04Z

DESCRIPTION

Help clarify which roles a user can use for the --role option by linking users to the Atlas User Roles page and the correct corresponding Atlas Admin API endpoint for each corresponding CLI command on the atlas-projects-apiKeys-create, atlas projects apiKeys assign, atlas organizations apiKeys assign, and atlas organizations apiKeys create pages.

Thanks for contributing to MongoDB Atlas CLI!

Before you submit your pull request, please review our contribution guidelines:
https://github.com/mongodb/mongodb-atlas-cli/blob/master/CONTRIBUTING.md

Please fill out the information below to help speed up the review process
and getting you pull request merged!
-->

Proposed changes

Jira ticket: DOCSP-47322

Closes #[issue number]

Checklist

I have signed the MongoDB CLA
I have added tests that prove my fix is effective or that my feature works
I have added any necessary documentation in document requirements section listed in CONTRIBUTING.md (if appropriate)
I have addressed the @mongodb/docs-cloud-team comments (if appropriate)
I have updated test/README.md (if an e2e test has been added)
I have run make fmt and formatted my code

Further comments

…ks to corresponding Atlas API endpoints, and link to the User Roles page.

jwilliams-mongo · 2025-02-25T21:24:03Z

internal/usage/usage.go

+	CreateProjectAPIKeyRoles                  = "Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. For the full list of accepted values, see the Items Enum for the corresponding :oas-atlas-tag:`Atlas API endpoint </Programmatic-API-Keys/operation/createProjectApiKey>`. To learn more about project level user roles, see :atlas:`/reference/user-roles/#project-roles`."    //nolint:gosec // This is just a message not a credential
+	AddProjectAPIKeyRoles                     = "Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. For the full list of accepted values, see the Items Enum for the corresponding :oas-atlas-tag:`Atlas API endpoint </Programmatic-API-Keys/operation/addProjectApiKey>`. To learn more about project level user roles, see :atlas:`/reference/user-roles/#project-roles`."       //nolint:gosec // This is just a message not a credential
+	CreateAPIKeyRoles                         = "Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. For the full list of accepted values, see the Items Enum for the corresponding :oas-atlas-tag:`Atlas API endpoint </Programmatic-API-Keys/operation/createApiKey>`. To learn more about organization level user roles, see :atlas:`/reference/user-roles/#organization-roles`." //nolint:gosec // This is just a message not a credential
+	UpdateAPIKeyRoles                         = "Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. For the full list of accepted values, see the Items Enum for the corresponding :oas-atlas-tag:`Atlas API endpoint </Programmatic-API-Keys/operation/updateApiKey>`. To learn more about organization level user roles, see :atlas:`/reference/user-roles/#organization-roles`." //nolint:gosec // This is just a message not a credential


I believe we should hard-code this link as this message appears in the CLI help text

jwilliams-mongo · 2025-02-25T21:29:59Z

internal/usage/usage.go

+	AtlasAPIKeyDescription                    = APIKeyDescription + " " + requiredForAtlas
+	CreateProjectAPIKeyRoles                  = "Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. For the full list of accepted values, see the Items Enum for the corresponding :oas-atlas-tag:`Atlas API endpoint </Programmatic-API-Keys/operation/createProjectApiKey>`. To learn more about project level user roles, see :atlas:`/reference/user-roles/#project-roles`."    //nolint:gosec // This is just a message not a credential
+	AddProjectAPIKeyRoles                     = "Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. For the full list of accepted values, see the Items Enum for the corresponding :oas-atlas-tag:`Atlas API endpoint </Programmatic-API-Keys/operation/addProjectApiKey>`. To learn more about project level user roles, see :atlas:`/reference/user-roles/#project-roles`."       //nolint:gosec // This is just a message not a credential
+	CreateAPIKeyRoles                         = "Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. For the full list of accepted values, see the Items Enum for the corresponding :oas-atlas-tag:`Atlas API endpoint </Programmatic-API-Keys/operation/createApiKey>`. To learn more about organization level user roles, see :atlas:`/reference/user-roles/#organization-roles`." //nolint:gosec // This is just a message not a credential


I believe we should hard-code this link as this message appears in the CLI help text

jwilliams-mongo · 2025-02-25T21:30:03Z

internal/usage/usage.go

-	AtlasAPIKeyRoles                          = APIKeyRoles + requiredForAtlas
+	AtlasAPIKeyDescription                    = APIKeyDescription + " " + requiredForAtlas
+	CreateProjectAPIKeyRoles                  = "Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. For the full list of accepted values, see the Items Enum for the corresponding :oas-atlas-tag:`Atlas API endpoint </Programmatic-API-Keys/operation/createProjectApiKey>`. To learn more about project level user roles, see :atlas:`/reference/user-roles/#project-roles`."    //nolint:gosec // This is just a message not a credential
+	AddProjectAPIKeyRoles                     = "Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. For the full list of accepted values, see the Items Enum for the corresponding :oas-atlas-tag:`Atlas API endpoint </Programmatic-API-Keys/operation/addProjectApiKey>`. To learn more about project level user roles, see :atlas:`/reference/user-roles/#project-roles`."       //nolint:gosec // This is just a message not a credential


I believe we should hard-code this link as this message appears in the CLI help text

jwilliams-mongo · 2025-02-25T21:30:06Z

internal/usage/usage.go

-	ProjectAPIKeyRoles                        = "Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey." //nolint:gosec // This is just a message not a credential
-	AtlasAPIKeyRoles                          = APIKeyRoles + requiredForAtlas
+	AtlasAPIKeyDescription                    = APIKeyDescription + " " + requiredForAtlas
+	CreateProjectAPIKeyRoles                  = "Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. For the full list of accepted values, see the Items Enum for the corresponding :oas-atlas-tag:`Atlas API endpoint </Programmatic-API-Keys/operation/createProjectApiKey>`. To learn more about project level user roles, see :atlas:`/reference/user-roles/#project-roles`."    //nolint:gosec // This is just a message not a credential


I believe we should hard-code this link as this message appears in the CLI help text

jwilliams-mongo · 2025-02-25T21:30:22Z

docs/command/atlas-organizations-apiKeys-assign.txt

     - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
   * - --role
-     - strings
+     - Atlas API endpoint </Programmatic-API-Keys/operation/updateApiKey>


I think this should still be strings

I think all of the "string" rows were replaced when the autogenerated files glitched over my role directives, so they're fixed now that I fixed up the links!

jwilliams-mongo · 2025-02-25T21:30:33Z

docs/command/atlas-organizations-apiKeys-create.txt

     - Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
   * - --role
-     - strings
+     - Atlas API endpoint </Programmatic-API-Keys/operation/createApiKey>


I think this should still be strings

jwilliams-mongo · 2025-02-25T21:30:42Z

docs/command/atlas-organizations-create.txt

+     - Description of the API key. Required when creating organizations authenticated with API Keys.
   * - --apiKeyRole
-     - strings
+     - Atlas API endpoint </Programmatic-API-Keys/operation/createApiKey>


jwilliams-mongo · 2025-02-25T21:30:46Z

docs/command/atlas-projects-apiKeys-assign.txt

     - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
   * - --role
-     - strings
+     - Atlas API endpoint </Programmatic-API-Keys/operation/addProjectApiKey>


jwilliams-mongo · 2025-02-25T21:30:54Z

docs/command/atlas-projects-apiKeys-create.txt

     - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
   * - --role
-     - strings
+     - Atlas API endpoint </Programmatic-API-Keys/operation/createProjectApiKey>


jwilliams-mongo

LGTM

andreaangiolillo

LGTM

(DOCSP-47322) Update --role option description to include correct lin…

378fb91

…ks to corresponding Atlas API endpoints, and link to the User Roles page.

elyse-mdb requested review from a team as code owners February 25, 2025 20:48

jwilliams-mongo reviewed Feb 25, 2025

View reviewed changes

(DOCSP-47322) Replace inline links with full URL and dochub.

04d61b7

jwilliams-mongo approved these changes Feb 26, 2025

View reviewed changes

andreaangiolillo approved these changes Mar 3, 2025

View reviewed changes

andreaangiolillo merged commit 37f565e into mongodb:master Mar 5, 2025
21 of 22 checks passed

elyse-mdb deleted the DOCSP-47322 branch March 5, 2025 22:40

(DOCSP-47322) [CLI] Update --role flag description to link to API docs and User Roles page #3689

(DOCSP-47322) [CLI] Update --role flag description to link to API docs and User Roles page #3689

Uh oh!

Conversation

elyse-mdb commented Feb 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

DESCRIPTION

Proposed changes

Checklist

Further comments

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jwilliams-mongo left a comment

Choose a reason for hiding this comment

Uh oh!

andreaangiolillo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

elyse-mdb commented Feb 25, 2025 •

edited

Loading