Skip to content

Commit e715244

Browse files
authored
Merge branch 'main' into revert-code
2 parents 067c000 + 523c2cb commit e715244

File tree

195 files changed

+5494
-1473
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

195 files changed

+5494
-1473
lines changed

.github/vale/styles/OpenSearch/HeadingCapitalization.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,5 @@ exceptions:
1111
- k # ignores lowercase k-NN
1212
- '[A-Z]{2,}' # ignores all acronyms
1313
- '([A-Z][a-z0-9]+){2,}' # ignores all camel case words
14-
- '\b\w+\s+API'
14+
- '\b\w+\s+API'
15+
- 'gRPC' # ignores gRPC acronym

.github/vale/styles/Vocab/OpenSearch/Words/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ Gantt
4444
[Gg]eospatial
4545
[Gg]eotile
4646
gibibyte
47+
gRPC
4748
[Hh]ashmap
4849
[Hh]ostname
4950
[Hh]yperparameters

DEVELOPER_GUIDE.md

Lines changed: 61 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
- [Query parameters](#query-parameters)
99
- [Path parameters](#path-parameters)
1010
- [Endpoints](#endpoints)
11-
11+
- [Example_Code](#example_code)
12+
1213
## Introduction
1314

1415
The `.md` documents in this repository are rendered into HTML pages using [Jekyll](https://jekyllrb.com/). These HTML pages are hosted on [opensearch.org](https://docs.opensearch.org/latest/).
@@ -88,6 +89,65 @@ All spec insert components accept the following arguments:
8889
- `component` (String; required): The name of the component to render, such as `query_parameters`, `path_parameters`, or `endpoints`.
8990
- `omit_header` (Boolean; Default is `false`): If set to `true`, the markdown header of the component will not be rendered.
9091

92+
### Example_Code
93+
94+
- `api` should not be placed for the `component: example_code` tag. `rest` is mapped to the correct API by regex mapping.
95+
- `rest` (String; required): The HTTP request line (`HTTP method` + `endpoint path`) that is regex mapped to the `opensearch-openapi.yaml`.
96+
97+
The following tags are included to help with additional needs:
98+
99+
- `body` (String; optional): The request body for the API call, using YAML `|` to preserve newlines and indentation.
100+
- `include_client_setup:` (Boolean; Default is `false`): If set to `true`, the client setup for the language will be rendered.
101+
- `skip` (Boolean; Default is `false`): If set to `true`, the language conversions will not render/re-render. Use for manual conversions.
102+
103+
To insert multi-language support for the `cat.allocation` API, use the following snippet:
104+
105+
```markdown
106+
<!-- spec_insert_start
107+
component: example_code
108+
rest: GET /_cat/allocation?v
109+
-->
110+
<!-- spec_insert_end -->
111+
```
112+
113+
To insert multi-language support for the `index` API with a request body, use the following snippet. The `|` is needed for multiline support for the body:
114+
115+
```markdown
116+
<!-- spec_insert_start
117+
component: example_code
118+
rest: PUT /_settings?expand_wildcards=all&analyze_wildcard
119+
body: |
120+
{
121+
"index": {
122+
"number_of_replicas": 2
123+
}
124+
}
125+
-->
126+
<!-- spec_insert_end -->
127+
```
128+
129+
To insert multi-language support for the `index` API and include the client setup for each language, use the following snippet:
130+
131+
```markdown
132+
<!-- spec_insert_start
133+
component: example_code
134+
rest: PUT /_settings?expand_wildcards=all&analyze_wildcard
135+
include_client_setup: true
136+
-->
137+
<!-- spec_insert_end -->
138+
```
139+
140+
To insert multi-language support for the `index` API but need to manually set the multi-language example for the `index` API, use the following snippet:
141+
142+
```markdown
143+
<!-- spec_insert_start
144+
component: example_code
145+
rest: PUT /_settings?expand_wildcards=all&analyze_wildcard
146+
skip: true
147+
-->
148+
<!-- spec_insert_end -->
149+
```
150+
91151
### Endpoints
92152
To insert endpoints for the `search` API, use the following snippet:
93153

_about/version-history.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ permalink: /version-history/
99

1010
OpenSearch version | Release highlights | Release date
1111
:--- | :--- | :---
12+
[3.2.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-3.2.0.md) | Updates Search Relevance Workbench. Makes gRPC APIs generally available. Introduces derived source, updates workload management, semantic field, and star tree functionality. Adds experimental Agentic Memory APIs and Job Scheduler APIs. For a full list of release highlights, see the Release Notes. | 19 August 2025
1213
[3.1.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-3.1.0.md) | Makes GPU acceleration for vector index builds generally available. Introduces memory-optimized search for Faiss indexes using Lucene HNSW, semantic field type for streamlined semantic search, and Search Relevance Workbench for search quality optimization. Makes star-tree indexes generally available with support for comprehensive query types. Enhances observability with ML Commons metrics integration, custom index support for OpenTelemetry data, and new PPL commands for JSON manipulation. Improves agent management with Update Agent API and persistent MCP tools. Includes security enhancements with immutable user objects and new resource sharing framework. For a full list of release highlights, see the Release Notes. | 24 June 2025
1314
[3.0.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-3.0.0.md) | Upgrades to Lucene 10 for improved indexing and vector search. Adds experimental gRPC support and pull-based ingestion from Kafka and Kinesis. Introduces GPU acceleration for vector operations and semantic sentence highlighting. Improves range query performance and hybrid search with z-score normalization. Adds plan-execute-reflect agents and native MCP protocol support for agentic workflows. Enhances security with a new Java agent replacing the Security Manager. Includes PPL query improvements with lookup, join, and subsearch commands. For a full list of release highlights, see the Release Notes. | 06 May 2025
1415
[2.19.3](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.19.3.md) | Improves Flow Framework with enhanced memory handling and workflow step processing. Fixes several Query Insights and Query Insights Dashboards issues. Implements security updates across multiple components. Updates infrastructure components and documentation across multiple plugins. | 22 July 2025

_api-reference/cat/cat-aliases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ include_deprecated: false
3737
-->
3838
## Query parameters
3939

40-
The following table lists the available query parameters. All query parameters are optional.
40+
The following table lists the available query parameters.
4141

4242
| Parameter | Data type | Description | Default |
4343
| :--- | :--- | :--- | :--- |

_api-reference/cat/cat-allocation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ include_deprecated: false
3636
-->
3737
## Query parameters
3838

39-
The following table lists the available query parameters. All query parameters are optional.
39+
The following table lists the available query parameters.
4040

4141
| Parameter | Data type | Description | Default |
4242
| :--- | :--- | :--- | :--- |
@@ -77,7 +77,7 @@ GET _cat/allocation/node_name_1,node_name_2,node_name_3
7777
The following response shows that eight shards are allocated to each of the two nodes available:
7878

7979
```json
80-
shards | disk.indices | disk.used | disk.avail | disk.total | disk.percent host | ip | node
81-
8 | 989.4kb | 25.9gb | 32.4gb | 58.4gb | 44 172.18.0.4 | 172.18.0.4 | odfe-node1
82-
8 | 962.4kb | 25.9gb | 32.4gb | 58.4gb | 44 172.18.0.3 | 172.18.0.3 | odfe-node2
80+
shards | disk.indices | disk.used | disk.avail | disk.total | disk.percent | host | ip | node
81+
8 | 989.4kb | 25.9gb | 32.4gb | 58.4gb | 44 | 172.18.0.4 | 172.18.0.4 | odfe-node1
82+
8 | 962.4kb | 25.9gb | 32.4gb | 58.4gb | 44 | 172.18.0.3 | 172.18.0.3 | odfe-node2
8383
```

_api-reference/cat/cat-cluster_manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ include_deprecated: false
3434
-->
3535
## Query parameters
3636

37-
The following table lists the available query parameters. All query parameters are optional.
37+
The following table lists the available query parameters.
3838

3939
| Parameter | Data type | Description | Default |
4040
| :--- | :--- | :--- | :--- |

_api-reference/cat/cat-count.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ include_deprecated: false
3636
-->
3737
## Query parameters
3838

39-
The following table lists the available query parameters. All query parameters are optional.
39+
The following table lists the available query parameters.
4040

4141
| Parameter | Data type | Description | Default |
4242
| :--- | :--- | :--- | :--- |

_api-reference/cat/cat-field-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ include_deprecated: false
3434
-->
3535
## Query parameters
3636

37-
The following table lists the available query parameters. All query parameters are optional.
37+
The following table lists the available query parameters.
3838

3939
| Parameter | Data type | Description | Default |
4040
| :--- | :--- | :--- | :--- |

_api-reference/cat/cat-health.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ include_deprecated: false
3434
-->
3535
## Query parameters
3636

37-
The following table lists the available query parameters. All query parameters are optional.
37+
The following table lists the available query parameters.
3838

3939
| Parameter | Data type | Description | Default |
4040
| :--- | :--- | :--- | :--- |

0 commit comments

Comments
 (0)