From 5bb9047dc4629869a3c717ba979893ade3020bea Mon Sep 17 00:00:00 2001 From: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Date: Fri, 10 Jan 2025 08:05:37 -0500 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Nathan Bower Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --- _community_members/theotr.md | 2 +- _posts/2025-01-22-Introducing-OpenSearch-JS-Client-3.0.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/_community_members/theotr.md b/_community_members/theotr.md index e8ee09b09..5016f9798 100644 --- a/_community_members/theotr.md +++ b/_community_members/theotr.md @@ -22,4 +22,4 @@ permalink: '/community/members/theo-truong.html' redirect_from: '/authors/theotr/' --- -**Theo Truong** is a Software Engineer at AWS working on OpenSearch clients and specification. +**Theo Truong** is a Software Engineer at AWS working on OpenSearch clients and API specification. diff --git a/_posts/2025-01-22-Introducing-OpenSearch-JS-Client-3.0.md b/_posts/2025-01-22-Introducing-OpenSearch-JS-Client-3.0.md index adbb9060e..b3f615ce5 100644 --- a/_posts/2025-01-22-Introducing-OpenSearch-JS-Client-3.0.md +++ b/_posts/2025-01-22-Introducing-OpenSearch-JS-Client-3.0.md @@ -13,7 +13,7 @@ has_math: false has_science_table: false --- -We're excited to announce the release of OpenSearch JavaScript client 3.0.0. This version introduces significant improvements, including enhanced readability, consistency, and a more accurate interface for interacting with OpenSearch clusters. +We're excited to announce the release of OpenSearch JavaScript client 3.0.0. This version introduces significant improvements, including enhanced readability and consistency and a more accurate interface for interacting with OpenSearch clusters. The new [API generator](https://github.com/opensearch-project/opensearch-js/tree/main/api_generator) enables frequent and accurate updates to the client, ensuring it reflects the latest changes in OpenSearch. @@ -21,7 +21,7 @@ The new [API generator](https://github.com/opensearch-project/opensearch-js/tree Version 3.0.0 introduces over 100 new API functions compared to version 2.13.0, all generated from the [OpenSearch API specification](https://github.com/opensearch-project/opensearch-api-specification), which currently covers about 60% of the OpenSearch API. All existing API functions have been updated to align with the latest API spec. -To keep things current, we've added a GitHub workflow that automatically updates the client every week, ensuring that the client is always up-to-date with the latest OpenSearch API. This means that you always have access to the latest OpenSearch features through the client without delay. +To keep things current, we've added a GitHub workflow that automatically updates the client every week, ensuring that the client is always up to date with the latest OpenSearch API. This means that you always have access to the latest OpenSearch features through the client. For the client repository maintainers, this automation reduces the manual effort required to sync the client with the API spec. It allows us to focus on improving the client's performance, stability, and functionality while addressing API function gaps by [adding the missing APIs to the API specification](https://github.com/opensearch-project/opensearch-api-specification?tab=readme-ov-file#welcome). With the new API generator, you'll encounter fewer issues related to outdated API functions, creating a smoother experience whether you're a maintainer or a user. @@ -35,7 +35,7 @@ These new type definitions make it easier for your IDE or AI coding assistants t This major update also removes features that are no longer needed or have been replaced by better alternatives: -- **No more HTTP method overrides:** Previously, some API functions allowed you to override the HTTP method using a `method` parameter. Now, `method` is treated as a query string parameter and using it may cause errors. To send custom requests, use the `client.http` namespace. +- **No more HTTP method overrides:** Previously, some API functions allowed you to override the HTTP method using a `method` parameter. Now `method` is treated as a query string parameter, and using it may cause errors. To send custom requests, use the `client.http` namespace. - **No camelCase parameters:** API functions now only accept parameters matching the OpenSearch API specification. These parameters align with what the OpenSearch server expects. - **Dropped support for older Node.js versions:** The client now requires Node.js 14 or later. If you're still using Node.js 10 or 12, we recommend upgrading to the latest LTS version. @@ -43,4 +43,4 @@ As with any major update, these updates, along with the new typing system, may i ## Share your feedback -We're excited to see the applications you build using the new OpenSearch JavaScript client 3.0.0. If you have questions or feedback, feel free to open an issue in the [JavaScript client GitHub repository](https://github.com/opensearch-project/opensearch-js). Your input helps us improve the client and make it easier for you to interact with OpenSearch clusters. \ No newline at end of file +We're excited to see the applications you build using the new OpenSearch JavaScript client 3.0.0. If you have questions or feedback, feel free to create an issue in the [JavaScript client GitHub repository](https://github.com/opensearch-project/opensearch-js). Your input helps us improve the client, making it easier for you to interact with OpenSearch clusters. \ No newline at end of file