From c7298e488bfd79f8d93ef32c1cfd7954c5ef0488 Mon Sep 17 00:00:00 2001 From: Artur Jankowski Date: Thu, 12 Sep 2024 10:15:02 +0200 Subject: [PATCH] docs: Add examples to file/folder metadata commands (#542) --- docs/files.md | 8 ++++++-- docs/folders.md | 8 ++++++-- src/commands/ai/text-gen.js | 1 + src/commands/files/metadata/add.js | 5 ++++- src/commands/files/metadata/set.js | 5 ++++- src/commands/folders/metadata/add.js | 5 ++++- src/commands/folders/metadata/set.js | 5 ++++- 7 files changed, 29 insertions(+), 8 deletions(-) diff --git a/docs/files.md b/docs/files.md index f9d0abee..5ac2b949 100644 --- a/docs/files.md +++ b/docs/files.md @@ -440,8 +440,10 @@ OPTIONS ALIASES $ box files:metadata:create -EXAMPLE +EXAMPLES box files:metadata:add 11111 --template-key employeeRecord --data "name=John Doe" --data department=Sales + box files:metadata:add 22222 --template-key myTemplate --data "multiselectkey1=[option1A,option1B]" --data + "multiselectkey2=[option2A]" ``` _See code: [src/commands/files/metadata/add.js](https://github.com/box/boxcli/blob/v3.15.0/src/commands/files/metadata/add.js)_ @@ -554,8 +556,10 @@ OPTIONS --template-key=template-key (required) The key of the metadata template to use -EXAMPLE +EXAMPLES box files:metadata:set 11111 --template-key employeeRecord --data "name=John Doe" --data department=Sales + box files:metadata:set 22222 --template-key myTemplate --data "multiselectkey1=[option1A,option1B]" --data + "multiselectkey2=[option2A]" ``` _See code: [src/commands/files/metadata/set.js](https://github.com/box/boxcli/blob/v3.15.0/src/commands/files/metadata/set.js)_ diff --git a/docs/folders.md b/docs/folders.md index d463d8d3..191d5dc4 100644 --- a/docs/folders.md +++ b/docs/folders.md @@ -527,8 +527,10 @@ OPTIONS ALIASES $ box folders:metadata:create -EXAMPLE +EXAMPLES box folders:metadata:add 22222 --template-key employeeRecord --data "name=John Doe" --data department=Sales + box folders:metadata:add 22222 --template-key myTemplate --data "multiselectkey1=[option1A,option1B]" --data + "multiselectkey2=[option2A]" ``` _See code: [src/commands/folders/metadata/add.js](https://github.com/box/boxcli/blob/v3.15.0/src/commands/folders/metadata/add.js)_ @@ -641,8 +643,10 @@ OPTIONS --template-key=template-key (required) The key of the metadata template to use -EXAMPLE +EXAMPLES box folders:metadata:set 22222 --template-key employeeRecord --data "name=John Doe" --data department=Sales + box folders:metadata:set 22222 --template-key myTemplate --data "multiselectkey1=[option1A,option1B]" --data + "multiselectkey2=[option2A]" ``` _See code: [src/commands/folders/metadata/set.js](https://github.com/box/boxcli/blob/v3.15.0/src/commands/folders/metadata/set.js)_ diff --git a/src/commands/ai/text-gen.js b/src/commands/ai/text-gen.js index c8e97ede..e0163ef9 100644 --- a/src/commands/ai/text-gen.js +++ b/src/commands/ai/text-gen.js @@ -14,6 +14,7 @@ class AiTextGenCommand extends BoxCommand { } options.prompt = flags.prompt; options.items = flags.items; + let answer = await this.client.ai.textGen({ prompt: options.prompt, items: options.items, diff --git a/src/commands/files/metadata/add.js b/src/commands/files/metadata/add.js index 2f268d6f..da8c5fd7 100644 --- a/src/commands/files/metadata/add.js +++ b/src/commands/files/metadata/add.js @@ -19,7 +19,10 @@ class FilesCreateMetadataCommand extends BoxCommand { FilesCreateMetadataCommand.aliases = [ 'files:metadata:create' ]; FilesCreateMetadataCommand.description = 'Add metadata to a file'; -FilesCreateMetadataCommand.examples = ['box files:metadata:add 11111 --template-key employeeRecord --data "name=John Doe" --data department=Sales']; +FilesCreateMetadataCommand.examples = [ + 'box files:metadata:add 11111 --template-key employeeRecord --data "name=John Doe" --data department=Sales', + 'box files:metadata:add 22222 --template-key myTemplate --data "multiselectkey1=[option1A,option1B]" --data "multiselectkey2=[option2A]"', +]; FilesCreateMetadataCommand._endpoint = 'post_files_id_metadata_id_id'; FilesCreateMetadataCommand.flags = { diff --git a/src/commands/files/metadata/set.js b/src/commands/files/metadata/set.js index 0793b9f9..2a49ffcf 100644 --- a/src/commands/files/metadata/set.js +++ b/src/commands/files/metadata/set.js @@ -18,7 +18,10 @@ class FilesSetMetadataCommand extends BoxCommand { } FilesSetMetadataCommand.description = 'Set metadata on a file'; -FilesSetMetadataCommand.examples = ['box files:metadata:set 11111 --template-key employeeRecord --data "name=John Doe" --data department=Sales']; +FilesSetMetadataCommand.examples = [ + 'box files:metadata:set 11111 --template-key employeeRecord --data "name=John Doe" --data department=Sales', + 'box files:metadata:set 22222 --template-key myTemplate --data "multiselectkey1=[option1A,option1B]" --data "multiselectkey2=[option2A]"', +]; FilesSetMetadataCommand.flags = { ...BoxCommand.flags, diff --git a/src/commands/folders/metadata/add.js b/src/commands/folders/metadata/add.js index 1496fc33..c2d82763 100644 --- a/src/commands/folders/metadata/add.js +++ b/src/commands/folders/metadata/add.js @@ -20,7 +20,10 @@ class FoldersCreateMetadataCommand extends BoxCommand { FoldersCreateMetadataCommand.aliases = [ 'folders:metadata:create' ]; FoldersCreateMetadataCommand.description = 'Add metadata to a folder'; -FoldersCreateMetadataCommand.examples = ['box folders:metadata:add 22222 --template-key employeeRecord --data "name=John Doe" --data department=Sales']; +FoldersCreateMetadataCommand.examples = [ + 'box folders:metadata:add 22222 --template-key employeeRecord --data "name=John Doe" --data department=Sales', + 'box folders:metadata:add 22222 --template-key myTemplate --data "multiselectkey1=[option1A,option1B]" --data "multiselectkey2=[option2A]"', +]; FoldersCreateMetadataCommand._endpoint = 'post_folders_id_metadata_id_id'; FoldersCreateMetadataCommand.flags = { diff --git a/src/commands/folders/metadata/set.js b/src/commands/folders/metadata/set.js index aa5487e8..59430427 100644 --- a/src/commands/folders/metadata/set.js +++ b/src/commands/folders/metadata/set.js @@ -18,7 +18,10 @@ class FoldersSetMetadataCommand extends BoxCommand { } FoldersSetMetadataCommand.description = 'Set metadata on a folder'; -FoldersSetMetadataCommand.examples = ['box folders:metadata:set 22222 --template-key employeeRecord --data "name=John Doe" --data department=Sales']; +FoldersSetMetadataCommand.examples = [ + 'box folders:metadata:set 22222 --template-key employeeRecord --data "name=John Doe" --data department=Sales', + 'box folders:metadata:set 22222 --template-key myTemplate --data "multiselectkey1=[option1A,option1B]" --data "multiselectkey2=[option2A]"', +]; FoldersSetMetadataCommand.flags = { ...BoxCommand.flags,