From 391a162679feabf6ad612b878e9566ce3d15bca7 Mon Sep 17 00:00:00 2001 From: sthetland Date: Tue, 13 Dec 2022 16:07:24 -0800 Subject: [PATCH] docs: remove obsolete 'event' generated docs (#1067) --- cli/docs/lacework_event.md | 44 -------------------- cli/docs/lacework_event_list.md | 58 --------------------------- cli/docs/lacework_event_open.md | 45 --------------------- cli/docs/lacework_event_show.md | 45 --------------------- integration/test_resources/help/event | 27 ------------- 5 files changed, 219 deletions(-) delete mode 100644 cli/docs/lacework_event.md delete mode 100644 cli/docs/lacework_event_list.md delete mode 100644 cli/docs/lacework_event_open.md delete mode 100644 cli/docs/lacework_event_show.md delete mode 100644 integration/test_resources/help/event diff --git a/cli/docs/lacework_event.md b/cli/docs/lacework_event.md deleted file mode 100644 index f4dd0b7fe..000000000 --- a/cli/docs/lacework_event.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "lacework event" -slug: lacework_event -hide_title: true ---- - -## lacework event - -Inspect Lacework events - -### Synopsis - -Inspect events reported by the Lacework platform - -### Options - -``` - -h, --help help for event -``` - -### Options inherited from parent commands - -``` - -a, --account string account subdomain of URL (i.e. .lacework.net) - -k, --api_key string access key id - -s, --api_secret string secret access key - --api_token string access token (replaces the use of api_key and api_secret) - --debug turn on debug logging - --json switch commands output from human-readable to json format - --nocache turn off caching - --nocolor turn off colors - --noninteractive turn off interactive mode (disable spinners, prompts, etc.) - --organization access organization level data sets (org admins only) - -p, --profile string switch between profiles configured at ~/.lacework.toml - --subaccount string sub-account name inside your organization (org admins only) -``` - -### SEE ALSO - -* [lacework](lacework.md) - A tool to manage the Lacework cloud security platform. -* [lacework event list](lacework_event_list.md) - List all events (default last 7 days) -* [lacework event open](lacework_event_open.md) - Open a specified event in a web browser -* [lacework event show](lacework_event_show.md) - Show details about a specific event - diff --git a/cli/docs/lacework_event_list.md b/cli/docs/lacework_event_list.md deleted file mode 100644 index bc336ba85..000000000 --- a/cli/docs/lacework_event_list.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "lacework event list" -slug: lacework_event_list -hide_title: true ---- - -## lacework event list - -List all events (default last 7 days) - -### Synopsis - -List all events for the last 7 days by default, or pass --start and --end to -specify a custom time period. You can also pass --serverity to filter by a -severity threshold. - -Additionally, pass --days to list events for a specified number of days. - -For example, to list all events from the last day with severity medium and above -(Critical, High and Medium) run: - - lacework events list --severity medium --days 1 - -``` -lacework event list [flags] -``` - -### Options - -``` - --days int list events for specified number of days (max: 7 days) - --end string end of the time range in UTC (format: yyyy-MM-ddTHH:mm:ssZ) - -h, --help help for list - --severity string filter events by severity threshold (critical, high, medium, low, info) - --start string start of the time range in UTC (format: yyyy-MM-ddTHH:mm:ssZ) -``` - -### Options inherited from parent commands - -``` - -a, --account string account subdomain of URL (i.e. .lacework.net) - -k, --api_key string access key id - -s, --api_secret string secret access key - --api_token string access token (replaces the use of api_key and api_secret) - --debug turn on debug logging - --json switch commands output from human-readable to json format - --nocache turn off caching - --nocolor turn off colors - --noninteractive turn off interactive mode (disable spinners, prompts, etc.) - --organization access organization level data sets (org admins only) - -p, --profile string switch between profiles configured at ~/.lacework.toml - --subaccount string sub-account name inside your organization (org admins only) -``` - -### SEE ALSO - -* [lacework event](lacework_event.md) - Inspect Lacework events - diff --git a/cli/docs/lacework_event_open.md b/cli/docs/lacework_event_open.md deleted file mode 100644 index e816a10ce..000000000 --- a/cli/docs/lacework_event_open.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "lacework event open" -slug: lacework_event_open -hide_title: true ---- - -## lacework event open - -Open a specified event in a web browser - -### Synopsis - -Open a specified event in a web browser. - -``` -lacework event open [flags] -``` - -### Options - -``` - -h, --help help for open -``` - -### Options inherited from parent commands - -``` - -a, --account string account subdomain of URL (i.e. .lacework.net) - -k, --api_key string access key id - -s, --api_secret string secret access key - --api_token string access token (replaces the use of api_key and api_secret) - --debug turn on debug logging - --json switch commands output from human-readable to json format - --nocache turn off caching - --nocolor turn off colors - --noninteractive turn off interactive mode (disable spinners, prompts, etc.) - --organization access organization level data sets (org admins only) - -p, --profile string switch between profiles configured at ~/.lacework.toml - --subaccount string sub-account name inside your organization (org admins only) -``` - -### SEE ALSO - -* [lacework event](lacework_event.md) - Inspect Lacework events - diff --git a/cli/docs/lacework_event_show.md b/cli/docs/lacework_event_show.md deleted file mode 100644 index d27018c8b..000000000 --- a/cli/docs/lacework_event_show.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "lacework event show" -slug: lacework_event_show -hide_title: true ---- - -## lacework event show - -Show details about a specific event - -### Synopsis - -Show details about a specific event. - -``` -lacework event show [flags] -``` - -### Options - -``` - -h, --help help for show -``` - -### Options inherited from parent commands - -``` - -a, --account string account subdomain of URL (i.e. .lacework.net) - -k, --api_key string access key id - -s, --api_secret string secret access key - --api_token string access token (replaces the use of api_key and api_secret) - --debug turn on debug logging - --json switch commands output from human-readable to json format - --nocache turn off caching - --nocolor turn off colors - --noninteractive turn off interactive mode (disable spinners, prompts, etc.) - --organization access organization level data sets (org admins only) - -p, --profile string switch between profiles configured at ~/.lacework.toml - --subaccount string sub-account name inside your organization (org admins only) -``` - -### SEE ALSO - -* [lacework event](lacework_event.md) - Inspect Lacework events - diff --git a/integration/test_resources/help/event b/integration/test_resources/help/event deleted file mode 100644 index e0d14a3bd..000000000 --- a/integration/test_resources/help/event +++ /dev/null @@ -1,27 +0,0 @@ -Command "event" is deprecated, Please use 'lacework alert' instead. - -Inspect events reported by the Lacework platform - -Usage: - -Aliases: - event, events - -Flags: - -h, --help help for event - -Global Flags: - -a, --account string account subdomain of URL (i.e. .lacework.net) - -k, --api_key string access key id - -s, --api_secret string secret access key - --api_token string access token (replaces the use of api_key and api_secret) - --debug turn on debug logging - --json switch commands output from human-readable to json format - --nocache turn off caching - --nocolor turn off colors - --noninteractive turn off interactive mode (disable spinners, prompts, etc.) - --organization access organization level data sets (org admins only) - -p, --profile string switch between profiles configured at ~/.lacework.toml - --subaccount string sub-account name inside your organization (org admins only) - -Use "lacework event [command] --help" for more information about a command.