larryh/corso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs Auto-Generation (#746)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
This commit is contained in:
github-actions[bot] 2022-09-03 01:43:46 +00:00 committed by GitHub
parent b1869bf32a
commit 8fe8dfeee6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 28 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/docs/cli/corso_backup_details_exchange.md
View File

@ -16,14 +16,20 @@ corso backup details exchange [flags]
--backup string ID of the backup containing the details to be shown --backup string ID of the backup containing the details to be shown
--contact strings Select backup details by contact ID; accepts * to select all contacts --contact strings Select backup details by contact ID; accepts * to select all contacts
--contact-folder strings Select backup details by contact folder ID; accepts * to select all contact folders --contact-folder strings Select backup details by contact folder ID; accepts * to select all contact folders
--contact-name string Select backup details where the contact name contains this value
--email strings Select backup details by emails ID; accepts * to select all emails --email strings Select backup details by emails ID; accepts * to select all emails
--email-folder strings Select backup details by email folder ID; accepts * to select all email folders --email-folder strings Select backup details by email folder ID; accepts * to select all email folders
--email-received-after string Select backup details where the email was received after this datetime --email-received-after string Restore mail where the email was received after this datetime
--email-received-before string Select backup details where the email was received before this datetime --email-received-before string Restore mail where the email was received before this datetime
--email-sender string Select backup details where the email sender matches this user id --email-sender string Restore mail where the email sender matches this user id
--email-subject string Select backup details where the email subject lines contain this value --email-subject string Restore mail where the email subject lines contain this value
--event strings Select backup details by event ID; accepts * to select all events --event strings Select backup details by event ID; accepts * to select all events
--event-calendar strings Select backup details by event calendar ID; accepts * to select all events --event-calendar strings Select backup details by event calendar ID; accepts * to select all events
--event-organizer string Select backup details where the event organizer user id contains this value
--event-recurs string Select backup details if the event recurs. Use --event-recurs false to select where the event does not recur.
--event-starts-after string Select backup details where the event starts after this datetime
--event-starts-before string Select backup details where the event starts before this datetime
--event-subject string Select backup details where the event subject contains this value
-h, --help help for exchange -h, --help help for exchange
--user strings Select backup details by user ID; accepts * to select all users --user strings Select backup details by user ID; accepts * to select all users
``` ```

9
docs/docs/cli/corso_repo_connect_s3.md
View File

@ -17,11 +17,10 @@ corso repo connect s3 [flags]
### Options ### Options
``` ```
--access-key string Access key ID (replaces the AWS_ACCESS_KEY_ID env variable). --bucket string Name of the S3 bucket (required).
--bucket string Name of the S3 bucket (required). --endpoint string Server endpoint for S3 communication. (default "s3.amazonaws.com")
--endpoint string Server endpoint for S3 communication. (default "s3.amazonaws.com") -h, --help help for s3
-h, --help help for s3 --prefix string Prefix applied to objects in the bucket.
--prefix string Prefix applied to objects in the bucket.
``` ```
### Options inherited from parent commands ### Options inherited from parent commands

9
docs/docs/cli/corso_repo_init_s3.md
View File

@ -17,11 +17,10 @@ corso repo init s3 [flags]
### Options ### Options
``` ```
--access-key string Access key ID (replaces the AWS_ACCESS_KEY_ID env variable). --bucket string Name of the S3 bucket (required).
--bucket string Name of the S3 bucket (required). --endpoint string Server endpoint for S3 communication. (default "s3.amazonaws.com")
--endpoint string Server endpoint for S3 communication. (default "s3.amazonaws.com") -h, --help help for s3
-h, --help help for s3 --prefix string Prefix applied to objects in the bucket.
--prefix string Prefix applied to objects in the bucket.
``` ```
### Options inherited from parent commands ### Options inherited from parent commands

10
docs/docs/cli/corso_restore_exchange.md
View File

@ -14,12 +14,22 @@ corso restore exchange [flags]
``` ```
--backup string ID of the backup to restore --backup string ID of the backup to restore
--contact strings Restore contacts by ID; accepts * to select all contacts
--contact-folder strings Restore all contacts within the folder ID; accepts * to select all contact folders
--contact-name string Restore contacts where the contact name contains this value
--email strings Restore emails by ID; accepts * to select all emails --email strings Restore emails by ID; accepts * to select all emails
--email-folder strings Restore all emails by folder ID; accepts * to select all email folders --email-folder strings Restore all emails by folder ID; accepts * to select all email folders
--email-received-after string Restore mail where the email was received after this datetime --email-received-after string Restore mail where the email was received after this datetime
--email-received-before string Restore mail where the email was received before this datetime --email-received-before string Restore mail where the email was received before this datetime
--email-sender string Restore mail where the email sender matches this user id --email-sender string Restore mail where the email sender matches this user id
--email-subject string Restore mail where the email subject lines contain this value --email-subject string Restore mail where the email subject lines contain this value
--event strings Restore events by ID; accepts * to select all events
--event-calendar strings Restore events by calendar ID; accepts * to select all event calendars
--event-organizer string Restore events where the event organizer user id contains this value
--event-recurs string Restore events if the event recurs. Use --event-recurs false to select where the event does not recur.
--event-starts-after string Restore events where the event starts after this datetime
--event-starts-before string Restore events where the event starts before this datetime
--event-subject string Restore events where the event subject contains this value
-h, --help help for exchange -h, --help help for exchange
--user strings Restore all data by user ID; accepts * to select all users --user strings Restore all data by user ID; accepts * to select all users
``` ```