Skip to content

Commit 4b8c1b8

Browse files
CLOUDP-329196: update doc links to new format - part 2 (#4028)
1 parent a2cb3d9 commit 4b8c1b8

12 files changed

+14
-63
lines changed

docs/command/atlas-api.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Admin API capabilities have their own release lifecycle, which you can check via
2222
This feature in public preview streamlines script development by letting you interact directly with any Atlas Administration API endpoint by using the Atlas CLI.
2323

2424
For more information on
25-
- Atlas Administration API see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/
25+
- Atlas Administration API see: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/
2626
- Getting started with the Atlas Administration API: https://www.mongodb.com/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access
2727

2828
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).

docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Options
4949
* - --file
5050
- string
5151
- true
52-
- Path to a JSON configuration file that defines connected orgs configurations. Note: Unsupported fields in the JSON file are ignored. To learn more about connected org configuration file format, see the request body in https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig.
52+
- Path to a JSON configuration file that defines connected orgs configurations. Note: Unsupported fields in the JSON file are ignored. To learn more about connected org configuration file format, see the request body in https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateconnectedorgconfig.
5353
* - -h, --help
5454
-
5555
- false

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Options
8181
* - --role
8282
- strings
8383
- false
84-
- 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 Atlas API endpoint: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKey. To learn more about organization level user roles, see: https://dochub.mongodb.org/core/atlas-org-roles. Passing this flag replaces preexisting data.
84+
- 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 Atlas API endpoint: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateapikey. To learn more about organization level user roles, see: https://dochub.mongodb.org/core/atlas-org-roles. Passing this flag replaces preexisting data.
8585

8686
Inherited Options
8787
-----------------

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Options
6363
* - --role
6464
- strings
6565
- true
66-
- 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 Atlas API endpoint: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey. To learn more about organization level user roles, see: https://dochub.mongodb.org/core/atlas-org-roles.
66+
- 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 Atlas API endpoint: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createapikey. To learn more about organization level user roles, see: https://dochub.mongodb.org/core/atlas-org-roles.
6767

6868
Inherited Options
6969
-----------------

docs/command/atlas-organizations-create.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Options
6565
* - --apiKeyRole
6666
- strings
6767
- false
68-
- 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 Atlas API endpoint: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey. To learn more about organization level user roles, see: https://dochub.mongodb.org/core/atlas-org-roles. Required when creating organizations authenticated with API Keys.
68+
- 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 Atlas API endpoint: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createapikey. To learn more about organization level user roles, see: https://dochub.mongodb.org/core/atlas-org-roles. Required when creating organizations authenticated with API Keys.
6969
* - --federationSettingsId
7070
- string
7171
- false

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Options
7575
* - --role
7676
- strings
7777
- true
78-
- 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 Atlas API endpoint: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey. To learn more about project level user roles, see: https://dochub.mongodb.org/core/atlas-proj-roles.
78+
- 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 Atlas API endpoint: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addprojectapikey. To learn more about project level user roles, see: https://dochub.mongodb.org/core/atlas-proj-roles.
7979

8080
Inherited Options
8181
-----------------

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Options
6464
* - --role
6565
- strings
6666
- true
67-
- 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 Atlas API endpoint: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey. To learn more about project level user roles, see: https://dochub.mongodb.org/core/atlas-proj-roles.
67+
- 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 Atlas API endpoint: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectapikey. To learn more about project level user roles, see: https://dochub.mongodb.org/core/atlas-proj-roles.
6868

6969
Inherited Options
7070
-----------------

internal/cli/api/api.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ func createRootAPICommand() *cobra.Command {
7575
Long: `This feature in public preview streamlines script development by letting you interact directly with any Atlas Administration API endpoint by using the Atlas CLI.
7676
7777
For more information on
78-
- Atlas Administration API see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/
78+
- Atlas Administration API see: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/
7979
- Getting started with the Atlas Administration API: https://www.mongodb.com/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access`,
8080
}
8181

internal/usage/usage.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,10 @@ dbName and collection are required only for built-in roles.`
144144
OrgIncludeDeleted = "Flag that indicates whether to include deleted organizations in the list. This option applies only to Ops Manager organizations. You can't return deleted Atlas or Cloud Manager organizations."
145145
APIKeyDescription = "Description of the API key."
146146
AtlasAPIKeyDescription = APIKeyDescription + " " + requiredForAtlas
147-
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 Atlas API endpoint: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey. To learn more about project level user roles, see: https://dochub.mongodb.org/core/atlas-proj-roles." //nolint:gosec // This is just a message not a credential
148-
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 Atlas API endpoint: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey. To learn more about project level user roles, see: https://dochub.mongodb.org/core/atlas-proj-roles." //nolint:gosec // This is just a message not a credential
149-
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 Atlas API endpoint: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey. To learn more about organization level user roles, see: https://dochub.mongodb.org/core/atlas-org-roles." //nolint:gosec // This is just a message not a credential
150-
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 Atlas API endpoint: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKey. To learn more about organization level user roles, see: https://dochub.mongodb.org/core/atlas-org-roles." //nolint:gosec // This is just a message not a credential
147+
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 Atlas API endpoint: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectapikey. To learn more about project level user roles, see: https://dochub.mongodb.org/core/atlas-proj-roles." //nolint:gosec // This is just a message not a credential
148+
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 Atlas API endpoint: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-addprojectapikey. To learn more about project level user roles, see: https://dochub.mongodb.org/core/atlas-proj-roles." //nolint:gosec // This is just a message not a credential
149+
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 Atlas API endpoint: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createapikey. To learn more about organization level user roles, see: https://dochub.mongodb.org/core/atlas-org-roles." //nolint:gosec // This is just a message not a credential
150+
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 Atlas API endpoint: https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateapikey. To learn more about organization level user roles, see: https://dochub.mongodb.org/core/atlas-org-roles." //nolint:gosec // This is just a message not a credential
151151
AtlasAPIKeyRoles = CreateAPIKeyRoles + " " + requiredForAtlas
152152
NotificationRegion = "Region that indicates which API URL to use."
153153
NotificationDelayMin = "Number of minutes to wait after an alert condition is detected before sending out the first notification."
@@ -406,7 +406,7 @@ dbName and collection are required only for built-in roles.`
406406
RequestedScopes = "Scopes that MongoDB applications will request from the authorization endpoint. "
407407
Protocol = "Protocol used to authenticate the user. Valid value is OIDC or SAML."
408408
IdentityProviderID = "Unique identifier of the identity provider."
409-
ConnectedOrgConfigFilename = "Path to a JSON configuration file that defines connected orgs configurations. Note: Unsupported fields in the JSON file are ignored. To learn more about connected org configuration file format, see the request body in https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig."
409+
ConnectedOrgConfigFilename = "Path to a JSON configuration file that defines connected orgs configurations. Note: Unsupported fields in the JSON file are ignored. To learn more about connected org configuration file format, see the request body in https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-updateconnectedorgconfig."
410410
AuditFilter = "JSON document that specifies which events to record. Escape any characters that may prevent parsing, such as single or double quotes, using a backslash (\\)."
411411
InvitationFile = "Path to an optional JSON configuration file that defines invitation settings. Note: Unsupported fields in the JSON file are ignored."
412412
InitDB = "Flag that uses a folder to be mapped into LOCAL deployment for initialization"

tools/cmd/api-generator/string.go

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -109,11 +109,3 @@ func safeSlugify(value string) string {
109109

110110
return result
111111
}
112-
113-
// ToURL creates a URL for the MongoDB Atlas API documentation based on a tag and operationId.
114-
// Both inputs are processed using safeSlugify before being inserted into the URL.
115-
func ToURL(tag, operationID string) string {
116-
safeTag := safeSlugify(tag)
117-
safeOperationID := safeSlugify(operationID)
118-
return "https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/" + safeTag + "/operation/" + safeOperationID
119-
}

0 commit comments

Comments
 (0)