From 592d3c637b5bd54a08aaaef3941b4f486df6e7e4 Mon Sep 17 00:00:00 2001 From: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Date: Tue, 30 Jan 2024 20:32:46 -0500 Subject: [PATCH] docs: Add generic commands to CLI docs (#4288) Co-authored-by: stellarsquall --- website/content/docs/commands/delete.mdx | 41 ++++++++++++++++++++++++ website/content/docs/commands/read.mdx | 41 ++++++++++++++++++++++++ website/content/docs/commands/update.mdx | 41 ++++++++++++++++++++++++ website/data/docs-nav-data.json | 12 +++++++ 4 files changed, 135 insertions(+) create mode 100644 website/content/docs/commands/delete.mdx create mode 100644 website/content/docs/commands/read.mdx create mode 100644 website/content/docs/commands/update.mdx diff --git a/website/content/docs/commands/delete.mdx b/website/content/docs/commands/delete.mdx new file mode 100644 index 0000000000..113baf51e2 --- /dev/null +++ b/website/content/docs/commands/delete.mdx @@ -0,0 +1,41 @@ +--- +layout: docs +page_title: delete - Command +description: |- + The "delete" command lets you delete Boundary resources. +--- + +# delete + +Command: `boundary delete` + +The `boundary delete` command lets you delete Boundary resources. +It is a generic command that runs a delete operation on a Boundary resource using the resource's ID. + +When you run this command, Boundary interprets it as the type-specific command. +For example, if you enter the `delete` command with a storage bucket ID, Boundary runs the `storage-buckets delete` command. +Help, error, or cURL output from the command may show the full command syntax. + +## Example + +This example deletes a storage bucket with the ID `sb_1234567890`: + +```shell-session +$ boundary delete -id sb_1234567890 +``` + +## Usage + + + +```shell-session +$ boundary delete [resource ID] [args] +``` + + + +### Command options + +- `-id=` - The ID of the resource you want to delete. + +@include 'cmd-option-note.mdx' \ No newline at end of file diff --git a/website/content/docs/commands/read.mdx b/website/content/docs/commands/read.mdx new file mode 100644 index 0000000000..86f9c04c46 --- /dev/null +++ b/website/content/docs/commands/read.mdx @@ -0,0 +1,41 @@ +--- +layout: docs +page_title: read - Command +description: |- + The "read" command lets you read Boundary resources. +--- + +# read + +Command: `boundary read` + +The `boundary read` command lets you read Boundary resources. +It is a generic command that runs a read operation on a Boundary resource using the resource's ID. + +When you run this command, Boundary interprets it as the type-specific command. +For example, if you enter the `read` command with a storage bucket ID, Boundary runs the `storage-buckets read` command. +Help, error, or cURL output from the command may show the full command syntax. + +## Example + +This example reads a storage bucket with the ID `sb_1234567890`: + +```shell-session +$ boundary read -id sb_1234567890 +``` + +## Usage + + + +```shell-session +$ boundary read [resource ID] [args] +``` + + + +### Command options + +- `-id=` - The ID of the resource you want to read. + +@include 'cmd-option-note.mdx' \ No newline at end of file diff --git a/website/content/docs/commands/update.mdx b/website/content/docs/commands/update.mdx new file mode 100644 index 0000000000..9bef2866e2 --- /dev/null +++ b/website/content/docs/commands/update.mdx @@ -0,0 +1,41 @@ +--- +layout: docs +page_title: update - Command +description: |- + The "update" command lets you update Boundary resources. +--- + +# update + +Command: `boundary update` + +The `boundary update` command lets you update Boundary resources. +It is a generic command that runs an update operation on a Boundary resource using the resource's ID. + +When you run this command, Boundary interprets it as the type-specific command. +For example, if you enter the `update` command with a storage bucket ID, Boundary runs the `storage-buckets update` command. +Help, error, or cURL output from the command may show the full command syntax. + +## Example + +This example updates a storage bucket with the ID `sb_1234567890` to add the name `devops` and the description `storage bucket for DevOps`: + +```shell-session +$ boundary update -id sb_1234567890 -name devops -description "storage bucket for DevOps" +``` + +## Usage + + + +```shell-session +$ boundary update [resource ID] [args] +``` + + + +### Command options + +- `-id=` - The ID of the resource you want to update. + +@include 'cmd-option-note.mdx' \ No newline at end of file diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index 26757f1141..4aa8d806ff 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -892,6 +892,10 @@ } ] }, + { + "title": "delete", + "path": "commands/delete" + }, { "title": "dev", "path": "commands/dev" @@ -1103,6 +1107,10 @@ } ] }, + { + "title": "read", + "path": "commands/read" + }, { "title": "roles", "routes": [ @@ -1347,6 +1355,10 @@ } ] }, + { + "title": "update", + "path": "commands/update" + }, { "title": "users", "routes": [