Refactor search template section (#10147) (#10152)

opensearch-trigger-bot[bot] · web-flow · commit 787bb58d0b55 · 2025-06-26T10:54:32.000Z
diff --git a/_api-reference/search-apis/index.md b/_api-reference/search-apis/index.md
@@ -38,4 +38,5 @@ These APIs help you test, debug, and optimize your search operations:
 These APIs allow you to work with search templates:
 
 - **[Search template]({{site.url}}{{site.baseurl}}/api-reference/search-apis/search-template/)**: Use search templates to run parameterized search queries.
-- **[Multi-search template]({{site.url}}{{site.baseurl}}/api-reference/search-apis/msearch-template/)**: Execute multiple search template requests in a single API call.
+- **[Multi-search template]({{site.url}}{{site.baseurl}}/api-reference/search-apis/search-template/msearch-template/)**: Execute multiple search template requests in a single API call.
+- **[Render template]({{site.url}}{{site.baseurl}}/api-reference/search-apis/search-template/render-template/)**: Previews the final query generated from a search template by substituting parameters without executing the search.
diff --git a/_api-reference/search-apis/search-template/index.md b/_api-reference/search-apis/search-template/index.md
@@ -2,11 +2,13 @@
 layout: default
 title: Search templates
 parent: Search APIs
+has_children: true
 nav_order: 90
 redirect_from:
   - /opensearch/search-template/
   - /search-plugins/search-template/
   - /api-reference/search-template/
+  - /api-reference/search-apis/search-template/
 ---
 
 # Search templates
@@ -43,13 +45,14 @@ GET _search/template
   }
 }
 ```
+{% include copy-curl.html %}
 
-This template runs the search on your entire cluster.
-To run this search on a specific index, add the index name to the request:
+This template runs the search on your entire cluster. To run this search on a specific index, add the index name to the request:
 
 ```json
 GET shakespeare/_search/template
 ```
+{% include copy-curl.html %}
 
 Specify the `from` and `size` parameters:
 
@@ -72,14 +75,16 @@ GET _search/template
   }
 }
 ```
+{% include copy-curl.html %}
 
 To improve the search experience, you can define defaults so the user doesn’t have to specify every possible parameter. If the parameter is not defined in the `params` section, OpenSearch uses the default value.
 
 The syntax for defining the default value for a variable `var` is as follows:
 
-```json
+```
 {% raw %}{{var}}{{^var}}default value{{/var}}{% endraw %}
 ```
+{% include copy.html %}
 
 This command sets the defaults for `from` as 10 and `size` as 10:
 
@@ -100,6 +105,7 @@ GET _search/template
   }
 }
 ```
+{% include copy-curl.html %}
 
 
 ## Save and execute search templates
@@ -118,7 +124,7 @@ POST _scripts/play_search_template
       "size": "{% raw %}{{size}}{{^size}}10{{/size}}{% endraw %}",
       "query": {
         "match": {
-          "play_name": "{{play_name}}"
+          "play_name": "{% raw %}{{play_name}}{% endraw %}"
         }
       }
     },
@@ -129,8 +135,7 @@ POST _scripts/play_search_template
 }
 ```
 
-Now you can reuse the template by referring to its `id` parameter.
-You can reuse this source template for different input values.
+Now you can reuse the template by referring to its `id` parameter. You can reuse this source template for different input values:
 
 ```json
 GET _search/template
@@ -143,7 +148,9 @@ GET _search/template
   }
 }
 ```
-#### Sample output
+{% include copy-curl.html %}
+
+## Example response
 
 ```json
 {
@@ -193,31 +200,9 @@ POST _render/template
   }
 }
 ```
+{% include copy-curl.html %}
 
-#### Sample output
-
-```json
-{
-  "template_output": {
-    "from": "0",
-    "size": "10",
-    "query": {
-      "match": {
-        "play_name": "Henry IV"
-      }
-    }
-  }
-}
-```
-
-The following render operations are supported:
-
-```json
-GET /_render/template
-POST /_render/template
-GET /_render/template/<id>
-POST /_render/template/<id>
-```
+For more information, see [Render Template API]({{site.url}}{{site.baseurl}}/api-reference/search-apis/search-template/render-template/).
 
 ## Advanced parameter conversion with search templates
 
@@ -231,6 +216,7 @@ Use the section tag in Mustache to represent conditions:
 ```json
 {% raw %}{{#var}}var{{/var}}{% endraw %}
 ```
+{% include copy.html %}
 
 When `var` is a Boolean value, this syntax acts as an `if` condition. The `{% raw %}{{#var}}{% endraw %}` and `{% raw %}{{/var}}{% endraw %}` tags insert the values placed between them only if `var` evaluates to `true`.
 
@@ -250,9 +236,9 @@ GET _search/template
   }
 }
 ```
+{% include copy-curl.html %}
 
-You can also design an `if-else` condition.
-This command sets `size` to `2` if `limit` is `true`. Otherwise, it sets `size` to `10`.
+You can also design an `if-else` condition. This command sets `size` to `2` if `limit` is `true`. Otherwise, it sets `size` to `10`:
 
 ```json
 GET _search/template
@@ -264,14 +250,16 @@ GET _search/template
   }
 }
 ```
+{% include copy-curl.html %}
 
 ### Loops
 
-You can also use the section tag to implement a for each loop:
+You can also use the section tag to implement a for-each loop:
 
 ```
 {% raw %}{{#var}}{{.}}{{/var}}{% endraw %}
 ```
+{% include copy.html %}
 
 When `var` is an array, the search template iterates through it and creates a `terms` query.
 
@@ -287,6 +275,7 @@ GET _search/template
   }
 }
 ```
+{% include copy-curl.html %}
 
 This template is rendered as:
 
@@ -328,6 +317,7 @@ GET _search/template
   }
 }
 ```
+{% include copy-curl.html %}
 
 Renders as:
 
@@ -360,6 +350,7 @@ GET _search/template
   }
 }
 ```
+{% include copy-curl.html %}
 
 Renders as:
 
@@ -406,22 +397,27 @@ GET _msearch/template
 {"id":"play_search_template","params":{"play_name":"Henry IV"}}
 ```
 
+For more information, see [Multi-search Template API]({{site.url}}{{site.baseurl}}/api-reference/search-apis/msearch-template/).
+
 ## Manage search templates
 
 To list all scripts, run the following command:
 
 ```json
 GET _cluster/state/metadata?pretty&filter_path=**.stored_scripts
 ```
+{% include copy-curl.html %}
 
 To retrieve a specific search template, run the following command:
 
 ```json
 GET _scripts/<name_of_search_template>
 ```
+{% include copy-curl.html %}
 
 To delete a search template, run the following command:
 
 ```json
 DELETE _scripts/<name_of_search_template>
 ```
+{% include copy-curl.html %}
diff --git a/_api-reference/search-apis/search-template/msearch-template.md b/_api-reference/search-apis/search-template/msearch-template.md
@@ -1,10 +1,12 @@
 ---
 layout: default
 title: Multi-search template 
-parent: Search APIs
-nav_order: 100
+parent: Search templates
+grand_parent: Search APIs
+nav_order: 20
 redirect_from:
   - /api-reference/msearch-template/
+  - /api-reference/search-apis/msearch-template/
 ---
 
 # Multi-search template 
diff --git a/_api-reference/search-apis/search-template/render-template.md b/_api-reference/search-apis/search-template/render-template.md
@@ -1,15 +1,17 @@
 ---
 layout: default
 title: Render template
-parent: Search APIs
-nav_order: 82
+parent: Search templates
+grand_parent: Search APIs
+nav_order: 10
 redirect_from:
   - /api-reference/render-template/
+  - /api-reference/search-apis/render-template/
 ---
 
 # Render template 
 
-The Render Template API renders a [search template]({{site.url}}{{site.baseurl}}/search-plugins/search-template/) as a search query.
+The Render Template API previews the final query generated from a [search template]({{site.url}}{{site.baseurl}}/search-plugins/search-template/) by substituting parameters without executing the search.
 
 ## Endpoints
 
@@ -22,17 +24,17 @@ POST /_render/template/<id>
 
 ## Path parameters
 
-The Render Template API supports the following optional path parameter. 
+The following table lists the available path parameters. All path parameters are optional.
 
-| Parameter | Type | Description |
+| Parameter | Data type | Description |
 | :--- | :--- | :--- |
 | `id` | String | The ID of the search template to render. |
 
 ## Request body fields
 
-The following options are supported in the request body of the Render Template API.
+The following table lists the available request body fields.
 
-| Parameter | Required | Type | Description | 
+| Parameter | Required | Data type | Description | 
 | :--- | :--- | :--- | :--- |
 | `id` | Conditional | String | The ID of the search template to render. Is not required if the ID is provided in the path or if an inline template is specified by the `source`. | 
 | `params` | No | Object | A list of key-value pairs that replace Mustache variables found in the search template. The key-value pairs must exist in the documents being searched. |
@@ -56,6 +58,7 @@ Both of the following request examples use the search template with the template
   }
 }
 ```
+{% include copy.html %}
 
 ### Render template using template ID
 
@@ -70,13 +73,13 @@ POST _render/template
   }
 }
 ```
-{% include copy.html %}
+{% include copy-curl.html %}
 
 ### Render template using `_source`
 
 If you don't want to use a saved template, or want to test a template before saving, you can test a template with the `_source` parameter using [Mustache](https://mustache.github.io/mustache.5.html) variables, as shown in the following example:
 
-```
+```json
 {
   "source": {
      "from": "{% raw %}{{from}}{{^from}}0{{/from}}{% endraw %}",
@@ -110,8 +113,4 @@ OpenSearch responds with information about the template's output:
     }
   }
 }
-```
-
-
-
-
+```
