Merge pull request #2 from kolchfa-aws/gh-workflow

Gh workflow

Author: kolchfa-aws

.github/PULL_REQUEST_TEMPLATE.md

@@ -7,6 +7,9 @@ _List any issues this PR will resolve, e.g. Closes [...]._
 ### Version
 _List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all._
 
+### Frontend features
+_If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional._ 
+
 ### Checklist
 - [ ] By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the [Developers Certificate of Origin](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).
 For more information on following Developer Certificate of Origin and signing off your commits, please check [here](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

.github/workflows/pr-checklist.yml

@@ -0,0 +1,30 @@
+name: PR Checklist
+
+on:
+  pull_request:
+    types: [opened]
+
+jobs:
+  add-checklist-and-assignees:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Comment PR with checklist
+        uses: peter-evans/create-or-update-comment@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          issue-number: ${{ github.event.pull_request.number }}
+          body: |
+            Thank you for submitting your PR. The PR states are Tech review -> Doc review -> Editorial review. If you're a developer submitting documentation for a feature you implemented, have the documentation reviewed by your team. If you need a tech review, let us know. Here's a checklist of the PR progression:
+            
+            ### PR Checklist
+            - [x] Tech Review
+            - [ ] Doc Review
+            - [ ] Editorial Review
+
+      - name: Add assignees to the PR
+        uses: peter-evans/create-or-update-comment@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          issue-number: ${{ github.event.pull_request.number }}
+          assignees: ${{ github.actor }}, kolchfa-aws

_about/version-history.md

@@ -9,6 +9,7 @@ permalink: /version-history/
 
 OpenSearch version | Release highlights | Release date  
 :--- | :--- | :--- 
+[2.15.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.15.0.md) | Includes parallel ingestion processing, SIMD support for exact search, and the ability to disable doc values for the k-NN field. Adds wildcard and derived field types. Improves performance for single-cardinality aggregations, rolling upgrades to remote-backed clusters, and more metrics for top N queries. For a full list of release highlights, see the Release Notes. | 25 June 2024
 [2.14.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.14.0.md) | Includes performance improvements to hybrid search and date histogram queries with multi-range traversal, ML model integration within the Ingest API, semantic cache for LangChain applications, low-level vector query interface for neural sparse queries, and improved k-NN search filtering. Provides an experimental tiered cache feature. For a full list of release highlights, see the Release Notes. | 14 May 2024
 [2.13.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.13.0.md) | Makes agents and tools and the OpenSearch Assistant Toolkit generally available. Introduces vector quantization within OpenSearch. Adds LLM guardrails and hybrid search with aggregations. Adds the Bloom filter skipping index for Apache Spark data sources, I/O-based admission control, and the ability to add an alerting cluster that manages all alerting tasks. For a full list of release highlights, see the Release Notes. | 2 April 2024
 [2.12.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.12.0.md) | Makes concurrent segment search and conversational search generally available. Provides an experimental OpenSearch Assistant Toolkit, including agents and tools, workflow automation, and OpenSearch Assistant for OpenSearch Dashboards UI. Adds a new match-only text field, query insights to monitor top N queries, and k-NN search on nested fields. For a full list of release highlights, see the Release Notes. | 20 February 2024

_api-reference/cat/index.md

@@ -24,17 +24,54 @@ GET _cat
 ```
 {% include copy-curl.html %}
 
+The response is an ASCII cat (`=^.^=`) and a list of operations:
+
+```
+=^.^=
+/_cat/allocation
+/_cat/segment_replication
+/_cat/segment_replication/{index}
+/_cat/shards
+/_cat/shards/{index}
+/_cat/cluster_manager
+/_cat/nodes
+/_cat/tasks
+/_cat/indices
+/_cat/indices/{index}
+/_cat/segments
+/_cat/segments/{index}
+/_cat/count
+/_cat/count/{index}
+/_cat/recovery
+/_cat/recovery/{index}
+/_cat/health
+/_cat/pending_tasks
+/_cat/aliases
+/_cat/aliases/{alias}
+/_cat/thread_pool
+/_cat/thread_pool/{thread_pools}
+/_cat/plugins
+/_cat/fielddata
+/_cat/fielddata/{fields}
+/_cat/nodeattrs
+/_cat/repositories
+/_cat/snapshots/{repository}
+/_cat/templates
+/_cat/pit_segments
+/_cat/pit_segments/{pit_id}
+```
+
 ## Optional query parameters
 
-You can use the following query parameters with any CAT API to filter your results.
+The root `_cat` API does not take any parameters, but individual APIs, such as `/_cat/nodes` accept the following query parameters.
 
 Parameter | Description
 :--- | :--- |
 `v` |  Provides verbose output by adding headers to the columns. It also adds some formatting to help align each of the columns together. All examples in this section include the `v` parameter.
 `help` | Lists the default and other available headers for a given operation.
 `h`  |  Limits the output to specific headers.
-`format` |  Returns the result in JSON, YAML, or CBOR formats.
-`sort` | Sorts the output by the specified columns.
+`format` |  The format in which to return the result. Valid values are `json`, `yaml`, `cbor`, and `smile`.
+`s` | Sorts the output by the specified columns.
 
 ### Query parameter usage examples
 
@@ -59,7 +96,6 @@ sample-alias1 sample-index-1 - - - -
 Without the verbose parameter, `v`, the response simply returns the alias names:
 
 ```
-
 .kibana .kibana_1 - - - -
 sample-alias1 sample-index-1 - - - -
 ```
@@ -72,6 +108,24 @@ To see all the available headers, use the `help` parameter:
 GET _cat/<operation_name>?help
 ```
 
+For example, to see the available headers for the CAT aliases operation, send the following request:
+
+```json
+GET _cat/aliases?help
+```
+{% include copy-curl.html %}
+
+The response contains the available headers:
+
+```
+alias          | a                | alias name
+index          | i,idx            | index alias points to
+filter         | f,fi             | filter
+routing.index  | ri,routingIndex  | index routing
+routing.search | rs,routingSearch | search routing
+is_write_index | w,isWriteIndex   | write index
+```
+
 ### Get a subset of headers
 
 To limit the output to a subset of headers, use the `h` parameter:
@@ -80,7 +134,71 @@ To limit the output to a subset of headers, use the `h` parameter:
 GET _cat/<operation_name>?h=<header_name_1>,<header_name_2>&v
 ```
 
+For example, to limit aliases to only the alias name and index, send the following request:
+
+```json
+GET _cat/aliases?h=alias,index
+```
+{% include copy-curl.html %}
+
+The response contains the requested information:
+
+```
+.kibana .kibana_1
+sample-alias1 sample-index-1
+```
+
 Typically, for any operation you can find out what headers are available using the `help` parameter, and then use the `h` parameter to limit the output to only the headers that you care about.
 
+### Sort by a header
+
+To sort the output by a header, use the `s` parameter:
+
+```json
+GET _cat/<operation_name>?s=<header_name_1>,<header_name_2>
+```
+
+For example, to sort aliases by alias and then index, send the following request:
+
+```json
+GET _cat/aliases?s=i,a
+```
+{% include copy-curl.html %}
+
+The response contains the requested information:
+
+```
+sample-alias2 sample-index-1
+sample-alias1 sample-index-2
+```
+
+### Retrieve data in JSON format
+
+By default, CAT APIs return data in `text/plain` format.
+
+To retrieve data in JSON format, use the `format=json` parameter:
+
+```json
+GET _cat/<operation_name>?format=json
+```
+
+For example, to retrieve aliases in JSON format, send the following request:
+
+```json
+GET _cat/aliases?format=json
+```
+{% include copy-curl.html %}
+
+The response contains data in JSON format:
+
+```json
+[
+  {"alias":".kibana","index":".kibana_1","filter":"-","routing.index":"-","routing.search":"-","is_write_index":"-"},
+  {"alias":"sample-alias-1","index":"sample-index-1","filter":"-","routing.index":"-","routing.search":"-","is_write_index":"-"}
+]
+```
+
+Other supported formats are [YAML](https://yaml.org/), [CBOR](https://cbor.io/), and [Smile](https://github.com/FasterXML/smile-format-specification).
+
 If you use the Security plugin, make sure you have the appropriate permissions.
 {: .note }

_api-reference/common-parameters.md

@@ -90,3 +90,37 @@ The following request specifies filters to limit the fields returned in the resp
 
 GET _search?filter_path=<field_name>.*,-<field_name>
 ```
+
+## Units
+
+OpenSearch APIs support the following units.
+
+### Time units
+
+The following table lists all supported time units.
+
+Units | Specify as
+:--- | :---
+Days | `d`
+Hours | `h`
+Minutes | `m`
+Seconds | `s`
+Milliseconds | `ms`
+Microseconds | `micros`
+Nanoseconds | `nanos`
+ 
+### Distance units
+
+The following table lists all supported distance units.
+
+Units | Specify as
+:--- | :---
+Miles | `mi` or `miles`
+Yards | `yd` or `yards`
+Feet | `ft` or `feet`
+Inches | `in` or `inch`
+Kilometers | `km` or `kilometers`
+Meters | `m` or `meters`
+Centimeters | `cm` or `centimeters`
+Millimeters | `mm` or `millimeters`
+Nautical miles | `NM`, `nmi`, or `nauticalmiles` 

_api-reference/document-apis/bulk.md

@@ -124,7 +124,9 @@ All actions support the same metadata: `_index`, `_id`, and `_require_alias`. If
   { "doc" : { "title": "World War Z" }, "doc_as_upsert": true }
   ```
 
-  You can specify a script for more complex document updates:
+  You can specify a script for more complex document updates by defining the script with the `source` or `id` from a document: 
+
+
 
   - Script
   ```json

_api-reference/index-apis/refresh.md

@@ -45,7 +45,7 @@ The following table lists the available query parameters. All query parameters a
 | :--- | :--- | :--- |
 | `ignore_unavailable` | Boolean | When `false`, the request returns an error when it targets a missing or closed index. Default is `false`.
 | `allow_no_indices` | Boolean | When `false`, the Refresh Index API returns an error when a wildcard expression, index alias, or `_all` targets only closed or missing indexes, even when the request is made against open indexes. Default is `true`. |
-| `expand_wildcard` | String | The type of index that the wildcard patterns can match. If the request targets data streams, this argument determines whether the wildcard expressions match any hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are `all`, `open`, `closed`, `hidden`, and `none`.
+| `expand_wildcards` | String | The type of index that the wildcard patterns can match. If the request targets data streams, this argument determines whether the wildcard expressions match any hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are `all`, `open`, `closed`, `hidden`, and `none`.
 
 
 

_api-reference/render-template.md

@@ -0,0 +1,114 @@
+---
+layout: default
+title: Render Template
+nav_order: 82
+---
+
+# Render Template 
+
+The Render Template API renders a [search template]({{site.url}}{{site.baseurl}}/search-plugins/search-template/) as a search query.
+
+## Paths and HTTP methods
+
+```
+GET /_render/template
+POST /_render/template
+GET /_render/template/<id>
+POST /_render/template/<id>
+```
+
+## Path parameters
+
+The Render Template API supports the following optional path parameter. 
+
+| Parameter | Type | Description |
+| :--- | :--- | :--- |
+| `id` | String | The ID of the search template to render. |
+
+## Request options
+
+The following options are supported in the request body of the Render Template API.
+
+| Parameter | Required | 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. |
+| `source` | Conditional | Object | An inline search template to render if a search template is not specified. Supports the same parameters as a [Search]({{site.url}}{{site.baseurl}}/api-reference/search/) API request and [Mustache](https://mustache.github.io/mustache.5.html) variables. | 
+
+## Example request
+
+Both of the following request examples use the search template with the template ID `play_search_template`:
+
+```json
+{
+  "source": {
+    "query": {
+      "match": {
+        "play_name": "{{play_name}}"
+      }
+    }
+  },
+  "params": {
+    "play_name": "Henry IV"
+  }
+}
+```
+
+### Render template using template ID
+
+The following example request validates a search template with the ID `play_search_template`:
+
+```json
+POST _render/template
+{
+  "id": "play_search_template",
+  "params": {
+    "play_name": "Henry IV"
+  }
+}
+```
+{% include copy.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:
+
+```
+{
+  "source": {
+    "from": "{{from}}{{^from}}10{{/from}}",
+    "size": "{{size}}{{^size}}10{{/size}}",
+    "query": {
+      "match": {
+        "play_name": "{{play_name}}"
+      }
+    }
+  },
+  "params": {
+    "play_name": "Henry IV"
+  }
+}
+```
+{% include copy.html %}
+
+## Example response
+
+OpenSearch responds with information about the template's output:
+
+```json
+{
+  "template_output": {
+    "from": "0",
+    "size": "10",
+    "query": {
+      "match": {
+        "play_name": "Henry IV"
+      }
+    }
+  }
+}
+```
+
+
+
+