Warn about escaping quotes in curl command (#632)

* Warn about escaping quotes in curl command Signed-off-by: Daniel Widdis <[email protected]> * Update wording Signed-off-by: Daniel Widdis <[email protected]> --------- Signed-off-by: Daniel Widdis <[email protected]>
opensearch-project · Apr 1, 2024 · bc87e88 · bc87e88
1 parent b86ea9c
commit bc87e88
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/sample-templates/README.md b/sample-templates/README.md
@@ -6,6 +6,8 @@ Each template is provided in both YAML and JSON format with identical functional
 The YAML templates include comments which give more insight into the template's usage.
 Use the corresponding `Content-Type` (`application/yaml` or `application/json`) when providing them as the body of a REST request.
 
+**Note:** Several of the templates use both the single quote (`'`) and double quote (`"`) characters which may create issues using the templates with `curl` on the command line and the template in `--data`. Escaping the single quotes or reading the template from a file is needed to work around this.
+
 You will need to update the `credentials` field with appropriate API keys.
 
 To create a workflow and provision the resources: