Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLOUDP-303333 Improve --file description for auto-generated commands #3709

Merged
merged 3 commits into from
Mar 5, 2025
Merged

CLOUDP-303333 Improve --file description for auto-generated commands #3709

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2c882c5
CLOUDP-303333 Improve --file description for auto-generated commands
fmenezes Mar 4, 2025
ed6bb2a
drive-by
fmenezes Mar 5, 2025
1574728
address comments
fmenezes Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/labeler.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ jobs:
if: env.review_needed == 'true' && steps.append_comment.outputs.previous_comment_id == ''
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL_DOCS }}
SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

this should fix docs bot messages

SLACK_WEBHOOK_TYPE: incoming_webhook
with:
payload: |
{
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-alertConfigurations-createAlertConfiguration.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-alertConfigurations-toggleAlertConfiguration.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-alertConfigurations-updateAlertConfiguration.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-alerts-acknowledgeAlert.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-atlasSearch-createAtlasSearchDeployment.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-atlasSearch-createAtlasSearchIndex.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-atlasSearch-createAtlasSearchIndexDeprecated.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-atlasSearch-updateAtlasSearchDeployment.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-atlasSearch-updateAtlasSearchIndex.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexByName.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-atlasSearch-updateAtlasSearchIndexDeprecated.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-auditing-updateAuditingConfiguration.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-awsClustersDns-toggleAwsCustomDns.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-cloudBackups-createBackupExportJob.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-cloudBackups-createBackupRestoreJob.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-cloudBackups-createExportBucket.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-cloudBackups-createServerlessBackupRestoreJob.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-cloudBackups-takeSnapshot.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-cloudBackups-updateBackupSchedule.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-cloudBackups-updateDataProtectionSettings.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-cloudBackups-updateSnapshotRetention.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-cloudMigrationService-createLinkToken.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - -h, --help
-
- false
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-cloudMigrationService-createPushMigration.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-cloudMigrationService-validateMigration.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-cloudProviderAccess-authorizeCloudProviderAccessRole.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-cloudProviderAccess-createCloudProviderAccessRole.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-clusterOutageSimulation-startOutageSimulation.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-clusters-createCluster.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-clusters-grantMongoDbEmployeeAccess.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-clusters-pinFeatureCompatibilityVersion.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-clusters-updateCluster.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-clusters-updateClusterAdvancedConfiguration.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-clusters-upgradeSharedCluster.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPatch.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-collectionLevelMetrics-pinNamespacesPut.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-collectionLevelMetrics-unpinNamespaces.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-customDatabaseRoles-createCustomDatabaseRole.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-customDatabaseRoles-updateCustomDatabaseRole.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-dataFederation-createDataFederationPrivateEndpoint.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-dataFederation-createFederatedDatabase.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-dataFederation-createOneDataFederationQueryLimit.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-dataFederation-updateFederatedDatabase.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
2 changes: 1 addition & 1 deletion docs/command/atlas-api-dataLakePipelines-createPipeline.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Options
* - --file
- string
- false
- path to the file which contains the api request contents
- path to the file which contains the api request contents, alternatively you may pass standard input
* - --groupId
- string
- true
Expand Down
Loading