CLOUDP-300821: [AtlasCLI] Update help text of commands with --file flags to clarify we will ignore not documented fields (#3683)

jeroenvervaeke · web-flow · commit 4c17545fa6fa · 2025-02-24T17:39:58.000Z
diff --git a/docs/command/atlas-alerts-settings-create.txt b/docs/command/atlas-alerts-settings-create.txt
@@ -52,7 +52,7 @@ Options
    * - -f, --file
      - string
      - false
-     - Path to the JSON configuration file that defines alert configuration settings. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.
+     - Path to the JSON configuration file that defines alert configuration settings. Note: Unsupported fields in the JSON file are ignored. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.
    * - -h, --help
      - 
      - false
diff --git a/docs/command/atlas-alerts-settings-update.txt b/docs/command/atlas-alerts-settings-update.txt
@@ -68,7 +68,7 @@ Options
    * - -f, --file
      - string
      - false
-     - Path to the JSON configuration file that defines alert configuration settings. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.
+     - Path to the JSON configuration file that defines alert configuration settings. Note: Unsupported fields in the JSON file are ignored. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.
    * - -h, --help
      - 
      - false
diff --git a/docs/command/atlas-backups-compliancePolicy-setup.txt b/docs/command/atlas-backups-compliancePolicy-setup.txt
@@ -38,7 +38,7 @@ Options
    * - -f, --file
      - string
      - true
-     - Path to a JSON configuration file that defines backup compliance policy settings.
+     - Path to a JSON configuration file that defines backup compliance policy settings. Note: Unsupported fields in the JSON file are ignored.
    * - --force
      - 
      - false
diff --git a/docs/command/atlas-clusters-create.txt b/docs/command/atlas-clusters-create.txt
@@ -81,7 +81,7 @@ Options
    * - -f, --file
      - string
      - false
-     - Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli.
+     - Path to an optional JSON configuration file that defines cluster settings. Note: Unsupported fields in the JSON file are ignored. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli.
 
        Mutually exclusive with --tier, --provider, --members, --region, --diskSizeGB, --mdbVersion, --biConnector, --type, --shards, --tag.
    * - -h, --help
diff --git a/docs/command/atlas-clusters-indexes-create.txt b/docs/command/atlas-clusters-indexes-create.txt
@@ -72,7 +72,7 @@ Options
    * - -f, --file
      - string
      - false
-     - Path to an optional JSON configuration file that defines index settings.
+     - Path to an optional JSON configuration file that defines index settings. Note: Unsupported fields in the JSON file are ignored.
 
        Mutually exclusive with --db, --collection, --key.
    * - -h, --help
diff --git a/docs/command/atlas-clusters-onlineArchives-create.txt b/docs/command/atlas-clusters-onlineArchives-create.txt
@@ -84,7 +84,7 @@ Options
    * - --file
      - string
      - false
-     - Path to an optional JSON configuration file that defines online archive settings. To learn more about online archive configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config.
+     - Path to an optional JSON configuration file that defines online archive settings. Note: Unsupported fields in the JSON file are ignored. To learn more about online archive configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config.
 
        Mutually exclusive with --db, --collection, --dateField, --dateFormat, --archiveAfter, --expireAfterDays, --partition.
    * - -h, --help
diff --git a/docs/command/atlas-clusters-onlineArchives-update.txt b/docs/command/atlas-clusters-onlineArchives-update.txt
@@ -72,7 +72,7 @@ Options
    * - --file
      - string
      - false
-     - Path to an optional JSON configuration file that defines online archive settings. To learn more about online archive configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config.
+     - Path to an optional JSON configuration file that defines online archive settings. Note: Unsupported fields in the JSON file are ignored. To learn more about online archive configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config.
 
        Mutually exclusive with --archiveAfter, --expireAfterDays.
    * - -h, --help
diff --git a/docs/command/atlas-clusters-update.txt b/docs/command/atlas-clusters-update.txt
@@ -83,7 +83,7 @@ Options
    * - -f, --file
      - string
      - false
-     - Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli.
+     - Path to an optional JSON configuration file that defines cluster settings. Note: Unsupported fields in the JSON file are ignored. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli.
 
        Mutually exclusive with --tier, --diskSizeGB, --enableTerminationProtection, --disableTerminationProtection, --tag.
    * - -h, --help
diff --git a/docs/command/atlas-clusters-upgrade.txt b/docs/command/atlas-clusters-upgrade.txt
@@ -76,7 +76,7 @@ Options
    * - -f, --file
      - string
      - false
-     - Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli.
+     - Path to an optional JSON configuration file that defines cluster settings. Note: Unsupported fields in the JSON file are ignored. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli.
 
        Mutually exclusive with --tier, --diskSizeGB, --mdbVersion, --enableTerminationProtection, --disableTerminationProtection, --tag.
    * - -h, --help
diff --git a/docs/command/atlas-dataFederation-create.txt b/docs/command/atlas-dataFederation-create.txt
@@ -68,7 +68,7 @@ Options
    * - -f, --file
      - string
      - false
-     - Path to an optional JSON configuration file that defines data federation settings. To learn more about data federation configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config.
+     - Path to an optional JSON configuration file that defines data federation settings. Note: Unsupported fields in the JSON file are ignored. To learn more about data federation configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config.
 
        Mutually exclusive with --region, --awsRoleId, --awsTestS3Bucket.
    * - -h, --help
diff --git a/docs/command/atlas-dataFederation-update.txt b/docs/command/atlas-dataFederation-update.txt
@@ -68,7 +68,7 @@ Options
    * - -f, --file
      - string
      - false
-     - Path to an optional JSON configuration file that defines data federation settings. To learn more about data federation configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config.
+     - Path to an optional JSON configuration file that defines data federation settings. Note: Unsupported fields in the JSON file are ignored. To learn more about data federation configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config.
 
        Mutually exclusive with --region, --awsRoleId, --awsTestS3Bucket.
    * - -h, --help
diff --git a/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt b/docs/command/atlas-federatedAuthentication-federationSettings-connectedOrgConfigs-update.txt
@@ -42,7 +42,7 @@ Options
    * - --file
      - string
      - true
-     - Path to a JSON configuration file that defines connected orgs configurations. 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.
+     - 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.
    * - -h, --help
      - 
      - false
diff --git a/docs/command/atlas-organizations-invitations-invite.txt b/docs/command/atlas-organizations-invitations-invite.txt
@@ -56,7 +56,7 @@ Options
    * - -f, --file
      - string
      - false
-     - Path to an optional JSON configuration file that defines invitation settings. To learn more about invitation configuration files for the Atlas CLI, see https://XXX.
+     - Path to an optional JSON configuration file that defines invitation settings. Note: Unsupported fields in the JSON file are ignored.
 
        Mutually exclusive with --role, --teamId.
    * - -h, --help
diff --git a/docs/command/atlas-organizations-invitations-update.txt b/docs/command/atlas-organizations-invitations-update.txt
@@ -59,6 +59,10 @@ Options
      - string
      - false
      - Email address for the user.
+   * - -f, --file
+     - string
+     - false
+     - Path to an optional JSON configuration file that defines invitation settings. Note: Unsupported fields in the JSON file are ignored.
    * - -h, --help
      - 
      - false
diff --git a/docs/command/atlas-projects-update.txt b/docs/command/atlas-projects-update.txt
@@ -56,7 +56,7 @@ Options
    * - -f, --file
      - string
      - true
-     - Path to the JSON configuration file that defines project configuration settings. To learn more about project configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/project-config-file.
+     - Path to the JSON configuration file that defines project configuration settings. Note: Unsupported fields in the JSON file are ignored. To learn more about project configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/project-config-file.
    * - -h, --help
      - 
      - false
diff --git a/docs/command/atlas-streams-connections-create.txt b/docs/command/atlas-streams-connections-create.txt
@@ -56,7 +56,7 @@ Options
    * - -f, --file
      - string
      - true
-     - Path to a JSON configuration file that defines an Atlas Stream Processing connection.
+     - Path to a JSON configuration file that defines an Atlas Stream Processing connection. Note: Unsupported fields in the JSON file are ignored.
    * - -h, --help
      - 
      - false
diff --git a/docs/command/atlas-streams-connections-update.txt b/docs/command/atlas-streams-connections-update.txt
@@ -56,7 +56,7 @@ Options
    * - -f, --file
      - string
      - true
-     - Path to a JSON configuration file that defines an Atlas Stream Processing connection.
+     - Path to a JSON configuration file that defines an Atlas Stream Processing connection. Note: Unsupported fields in the JSON file are ignored.
    * - -h, --help
      - 
      - false
diff --git a/docs/command/atlas-streams-privateLinks-create.txt b/docs/command/atlas-streams-privateLinks-create.txt
@@ -40,7 +40,7 @@ Options
    * - -f, --file
      - string
      - true
-     - Path to a JSON configuration file that defines an Atlas Stream Processing PrivateLink endpoint.
+     - Path to a JSON configuration file that defines an Atlas Stream Processing PrivateLink endpoint. Note: Unsupported fields in the JSON file are ignored.
    * - -h, --help
      - 
      - false
diff --git a/internal/cli/organizations/invitations/update.go b/internal/cli/organizations/invitations/update.go
@@ -126,6 +126,7 @@ func UpdateBuilder() *cobra.Command {
 		},
 	}
 
+	cmd.Flags().StringVarP(&opts.filename, flag.File, flag.FileShort, "", usage.InvitationFile)
 	cmd.Flags().StringVar(&opts.username, flag.Email, "", usage.Email)
 	cmd.Flags().StringSliceVar(&opts.roles, flag.Role, []string{}, usage.OrgRole+usage.UpdateWarning)
 	opts.AddOrgOptFlags(cmd)
diff --git a/internal/usage/usage.go b/internal/usage/usage.go

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ Options`
`52`	`52`	`* - -f, --file`
`53`	`53`	`- string`
`54`	`54`	`- false`
`55`		`- - Path to the JSON configuration file that defines alert configuration settings. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.`
	`55`	`+ - Path to the JSON configuration file that defines alert configuration settings. Note: Unsupported fields in the JSON file are ignored. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.`
`56`	`56`	`* - -h, --help`
`57`	`57`	`-`
`58`	`58`	`- false`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ Options`
`68`	`68`	`* - -f, --file`
`69`	`69`	`- string`
`70`	`70`	`- false`
`71`		`- - Path to the JSON configuration file that defines alert configuration settings. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.`
	`71`	`+ - Path to the JSON configuration file that defines alert configuration settings. Note: Unsupported fields in the JSON file are ignored. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.`
`72`	`72`	`* - -h, --help`
`73`	`73`	`-`
`74`	`74`	`- false`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ Options`
`38`	`38`	`* - -f, --file`
`39`	`39`	`- string`
`40`	`40`	`- true`
`41`		`- - Path to a JSON configuration file that defines backup compliance policy settings.`
	`41`	`+ - Path to a JSON configuration file that defines backup compliance policy settings. Note: Unsupported fields in the JSON file are ignored.`
`42`	`42`	`* - --force`
`43`	`43`	`-`
`44`	`44`	`- false`