From 8a8b5bbb13f5df909811a69129e0eb1097c393cf Mon Sep 17 00:00:00 2001 From: Yury-Fridlyand Date: Mon, 22 Aug 2022 19:23:56 -0700 Subject: [PATCH] Add small README for each project being released. Signed-off-by: Yury-Fridlyand --- src/OpenSearch.Client.JsonNetSerializer/README.md | 1 + src/OpenSearch.Client/README.md | 3 +++ src/OpenSearch.Net.VirtualizedCluster/README.md | 1 + src/OpenSearch.Net/README.md | 3 +++ 4 files changed, 8 insertions(+) create mode 100644 src/OpenSearch.Client.JsonNetSerializer/README.md create mode 100644 src/OpenSearch.Client/README.md create mode 100644 src/OpenSearch.Net.VirtualizedCluster/README.md create mode 100644 src/OpenSearch.Net/README.md diff --git a/src/OpenSearch.Client.JsonNetSerializer/README.md b/src/OpenSearch.Client.JsonNetSerializer/README.md new file mode 100644 index 0000000000..369a321a79 --- /dev/null +++ b/src/OpenSearch.Client.JsonNetSerializer/README.md @@ -0,0 +1 @@ +An auxiliary tool used by `OpenSearch.Client` to serialize and deserialize data. diff --git a/src/OpenSearch.Client/README.md b/src/OpenSearch.Client/README.md new file mode 100644 index 0000000000..35ec1dd1c4 --- /dev/null +++ b/src/OpenSearch.Client/README.md @@ -0,0 +1,3 @@ +`OpenSearch.Client` is a high level OpenSearch .NET client that still maps very closely to the original OpenSearch API. All requests and responses are exposed through types, making it ideal for getting up and running quickly. + +Under the covers, `OpenSearch.Client` uses the `OpenSearch.Net` low level client to dispatch requests and responses, using and extending many of the types within `OpenSearch.Net`. The low level client itself is still exposed on the high level client through the `.LowLevel` property. diff --git a/src/OpenSearch.Net.VirtualizedCluster/README.md b/src/OpenSearch.Net.VirtualizedCluster/README.md new file mode 100644 index 0000000000..2894ccab02 --- /dev/null +++ b/src/OpenSearch.Net.VirtualizedCluster/README.md @@ -0,0 +1 @@ +A utility used by unit tests of `OpenSearch.Net` and `OpenSearch.Client`. It allows to create a fake virtual OpenSearch cluster to test and debug REST API calls. diff --git a/src/OpenSearch.Net/README.md b/src/OpenSearch.Net/README.md new file mode 100644 index 0000000000..1dd52afe70 --- /dev/null +++ b/src/OpenSearch.Net/README.md @@ -0,0 +1,3 @@ +A low-level, dependency free OpenSearch .Net client. + +It provides a one-to-one mapping with the OpenSearch REST API. The client is completely matches the official REST API specification and supports all OpenSearch features. The client also has support for load balancing and cluster failover and all client method calls have both synchronous and asynchronous variants