From b6157e9b26d69e0ca22de43e14d0ffc3b4aba2d6 Mon Sep 17 00:00:00 2001 From: Islam Aleiv Date: Thu, 27 Jun 2024 15:08:10 +0200 Subject: [PATCH] Update docs --- .../references/cli/defradb_client_collection_create.md | 4 ++-- docs/website/references/cli/defradb_client_query.md | 10 ++++++++++ 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/website/references/cli/defradb_client_collection_create.md b/docs/website/references/cli/defradb_client_collection_create.md index 69b6aee8fa..5425e3f860 100644 --- a/docs/website/references/cli/defradb_client_collection_create.md +++ b/docs/website/references/cli/defradb_client_collection_create.md @@ -12,7 +12,7 @@ Options: and permissions are controlled by ACP (Access Control Policy). -e, --encrypt - Encrypt flag specified if the document needs to be encrypted. If set DefraDB will generate a + Encrypt flag specified if the document needs to be encrypted. If set, DefraDB will generate a symmetric key for encryption using AES-GCM. Example: create from string: @@ -39,7 +39,7 @@ defradb client collection create [-i --identity] [-e --encrypt] [flag ### Options ``` - -e, --encrypt Encryption key used to encrypt/decrypt the document + -e, --encrypt Flag to enable encryption of the document -f, --file string File containing document(s) -h, --help help for create ``` diff --git a/docs/website/references/cli/defradb_client_query.md b/docs/website/references/cli/defradb_client_query.md index ec868456b1..7c9b8e72fc 100644 --- a/docs/website/references/cli/defradb_client_query.md +++ b/docs/website/references/cli/defradb_client_query.md @@ -6,6 +6,15 @@ Send a DefraDB GraphQL query request Send a DefraDB GraphQL query request to the database. +Options: + -i, --identity + Marks the document as private and set the identity as the owner. The access to the document + and permissions are controlled by ACP (Access Control Policy). + + -e, --encrypt + Encrypt flag specified if the document needs to be encrypted. If set, DefraDB will generate a + symmetric key for encryption using AES-GCM. + A query request can be sent as a single argument. Example command: defradb client query 'query { ... }' @@ -30,6 +39,7 @@ defradb client query [-i --identity] [request] [flags] ### Options ``` + -e, --encrypt Flag to enable encryption of the document -f, --file string File containing the query request -h, --help help for query ```