Added guide for using raw JSON REST requests with low-level client. #406

Djcarrillo6 · 2023-10-22T21:59:13Z

Description

Adds a new guide that demonstrates how to interact with the OpenSearch REST API using the OpenSearch .NET low-level client by executing raw JSON REST requests. It covers a number of operations such as setting up an OpenSearch instance, indexing document data, and executing CRUD operations (CREATE, READ, UPDATE and DELETE) on documents in the index.

Issues Resolved

Resolves issue 403

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

dblock

Good start.

Remove any usage of higher level classes that aren't raw request/response.
Write a working sample and put it into samples so we can make sure this code works.

guides/using-json-rest-requests.md

Djcarrillo6 · 2023-10-23T21:50:31Z

Good start.

Remove any usage of higher level classes that aren't raw request/response.

Write a working sample and put it into samples so we can make sure this code works.

@dblock @Xtansia If I'm not mistaken, this .NET client repo does not currently have a "samples" directory like the Python client does. Should I create that new directory here and place my working sample in that location? Or should I just attach the sample in the same "guides" directory where the MD files live?

dblock · 2023-10-24T16:02:35Z

@dblock @Xtansia If I'm not mistaken, this .NET client repo does not currently have a "samples" directory like the Python client does. Should I create that new directory here and place my working sample in that location? Or should I just attach the sample in the same "guides" directory where the MD files live?

Please create one!

Djcarrillo6 · 2023-10-25T02:50:17Z

@dblock I added the new sample directory and added a working sample for my guide. I also change the name of guide file to match what the Python client guide used.

dblock

Looks better! Would format text a bit in json.md.

Add a link from USERS_GUIDE to this guide too?

Will leave this for a proper CR for @Xtansia or someone who's a maintainer here. I would check that these examples properly throw errors.

Djcarrillo6 · 2023-10-27T22:01:01Z

Hey @Xtansia, would you like me to add a link to this guide in the USER_GUIDE.md file? If so, which section to you think is best with respect to the guide's link placement.

Xtansia

@Djcarrillo6 A few points:

Rather than using new CancellationToken() you should use CancellationToken.None
The sample code should get added to a new project so that it actually gets compiled
As far as linking the guide, I think we should add an Advanced Features section like some of the other clients have: https://github.com/opensearch-project/opensearch-py/blob/main/USER_GUIDE.md#advanced-features

Djcarrillo6 · 2023-11-02T03:00:27Z

@Djcarrillo6 A few points:

Rather than using new CancellationToken() you should use CancellationToken.None

The sample code should get added to a new project so that it actually gets compiled

As far as linking the guide, I think we should add an Advanced Features section like some of the other clients have: https://github.com/opensearch-project/opensearch-py/blob/main/USER_GUIDE.md#advanced-features

@Xtansia what would adding the sample to a new project entail? Could I just add the sample file to the src/OpenSearch.Net directory?

@Djcarrillo6 A few points:

Rather than using new CancellationToken() you should use CancellationToken.None

The sample code should get added to a new project so that it actually gets compiled

As far as linking the guide, I think we should add an Advanced Features section like some of the other clients have: https://github.com/opensearch-project/opensearch-py/blob/main/USER_GUIDE.md#advanced-features

@Xtansia Can you detail how would I would correctly add this sample to a new project within the repo?

Xtansia · 2023-11-02T06:33:24Z

@Djcarrillo6 You can create and add a new project with the dotnet CLI:

dotnet new console -o samples/Samples
dotnet sln add samples/Samples

USER_GUIDE.md

samples/Samples/Program.cs

samples/Samples/Samples.csproj

guides/json.md

samples/Samples/Samples.csproj

samples/Samples/Program.cs

USER_GUIDE.md

guides/json.md

dblock

Let's make a subfolder for the sample and call it "RawJsonSample"?

dblock · 2023-11-03T15:10:43Z

guides/json.md

+            number_of_shards = 4
+        }
+    }
+};


Is there a JSON/string version of this? Not sure what's best for this example, maybe both?

Djcarrillo6 · 2023-11-03T20:01:39Z

@Xtansia I added the new folder structure & converted the sample to use raw JSON to match the guide implementation as @dblock requested.

Xtansia

If you're using a string body, you should use PostData.String rather than PostData.Serializable. The guide examples need to be updated to match the sample code. It'd be good to add a section to the guide informing users about the different types of PostData they can use with examples.

Signed-off-by: Djcarrillo6 <[email protected]> Added sample for using raw JSON REST requests with low-level client. Signed-off-by: Djcarrillo6 <[email protected]> Added sample for using raw JSON REST requests with low-level client opensearch-project#2 Signed-off-by: Djcarrillo6 <[email protected]> Created new samples project & PR review changes. Signed-off-by: Djcarrillo6 <[email protected]> Aligned action examples with Python guide. Signed-off-by: Djcarrillo6 <[email protected]> PR change requests. Signed-off-by: Djcarrillo6 <[email protected]> Changed to raw JSON in sample code. Signed-off-by: Djcarrillo6 <[email protected]> Added new section to the guide for using PostData.Serializable() Signed-off-by: Djcarrillo6 <[email protected]>

Djcarrillo6 · 2023-11-12T01:31:05Z

If you're using a string body, you should use PostData.String rather than PostData.Serializable. The guide examples need to be updated to match the sample code. It'd be good to add a section to the guide informing users about the different types of PostData they can use with examples.

@Xtansia I made the change to PostData.String and added a section to the guide informing users about the different PostData they can use with examples. Let me know if you'd like anything changed

Signed-off-by: Thomas Farr <[email protected]>

dblock · 2023-11-13T13:54:50Z

Looking at how this is done in the .NET client, would aliasing LowLevel to .http make sense to make the API more digestable? Similar to opensearch-project/opensearch-py#544.

Djcarrillo6 requested review from anirudha, dblock, joshuali925, Xtansia, VachaShah, MaxKsyunz and Yury-Fridlyand as code owners October 22, 2023 21:59

dblock reviewed Oct 23, 2023

View reviewed changes

guides/using-json-rest-requests.md Outdated Show resolved Hide resolved

guides/using-json-rest-requests.md Outdated Show resolved Hide resolved

guides/using-json-rest-requests.md Outdated Show resolved Hide resolved

Xtansia added the OSCI-2023 label Oct 23, 2023

Djcarrillo6 force-pushed the feat/guides-json branch 2 times, most recently from e4d1de2 to 9991b1d Compare October 25, 2023 02:48

dblock reviewed Oct 25, 2023

View reviewed changes

Xtansia requested changes Nov 1, 2023

View reviewed changes

Djcarrillo6 force-pushed the feat/guides-json branch from 9991b1d to cc3e190 Compare November 2, 2023 22:19

Djcarrillo6 requested a review from Xtansia November 2, 2023 22:20

Xtansia requested changes Nov 2, 2023

View reviewed changes

USER_GUIDE.md Outdated Show resolved Hide resolved

samples/Samples/Program.cs Outdated Show resolved Hide resolved

samples/Samples/Samples.csproj Show resolved Hide resolved

samples/Samples/Samples.csproj Outdated Show resolved Hide resolved

guides/json.md Show resolved Hide resolved

Djcarrillo6 force-pushed the feat/guides-json branch from cc3e190 to 6e38e9f Compare November 3, 2023 01:22

Djcarrillo6 requested a review from Xtansia November 3, 2023 01:23

Xtansia requested changes Nov 3, 2023

View reviewed changes

samples/Samples/Samples.csproj Outdated Show resolved Hide resolved

samples/Samples/Program.cs Outdated Show resolved Hide resolved

USER_GUIDE.md Outdated Show resolved Hide resolved

guides/json.md Outdated Show resolved Hide resolved

Djcarrillo6 force-pushed the feat/guides-json branch from 6e38e9f to f8ca895 Compare November 3, 2023 07:49

Djcarrillo6 requested a review from Xtansia November 3, 2023 07:50

dblock reviewed Nov 3, 2023

View reviewed changes

guides/json.md

number_of_shards = 4

}

}

};

Copy link

Member

dblock Nov 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a JSON/string version of this? Not sure what's best for this example, maybe both?

Djcarrillo6 force-pushed the feat/guides-json branch from f8ca895 to 8584657 Compare November 3, 2023 20:00

Xtansia added the skip-changelog label Nov 6, 2023

Xtansia requested changes Nov 6, 2023

View reviewed changes

Djcarrillo6 force-pushed the feat/guides-json branch from 8584657 to c7360b2 Compare November 12, 2023 01:29

Djcarrillo6 requested a review from Xtansia November 12, 2023 01:31

Xtansia added 2 commits November 13, 2023 17:27

Expand description of PostData types

38f07ef

Signed-off-by: Thomas Farr <[email protected]>

Complete working sample

1b3954a

Signed-off-by: Thomas Farr <[email protected]>

Xtansia approved these changes Nov 13, 2023

View reviewed changes

Xtansia merged commit 1924be9 into opensearch-project:main Nov 13, 2023
34 of 36 checks passed

dblock mentioned this pull request Nov 13, 2023

[FEATURE] Make raw JSON REST requests to OpenSearch #403

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added guide for using raw JSON REST requests with low-level client. #406

Added guide for using raw JSON REST requests with low-level client. #406

Djcarrillo6 commented Oct 22, 2023

dblock left a comment

Djcarrillo6 commented Oct 23, 2023 •

edited

Loading

dblock commented Oct 24, 2023

Djcarrillo6 commented Oct 25, 2023

dblock left a comment

Djcarrillo6 commented Oct 27, 2023

Xtansia left a comment

Djcarrillo6 commented Nov 2, 2023

Xtansia commented Nov 2, 2023

dblock left a comment

dblock Nov 3, 2023

Djcarrillo6 commented Nov 3, 2023

Xtansia left a comment

Djcarrillo6 commented Nov 12, 2023

dblock commented Nov 13, 2023

Added guide for using raw JSON REST requests with low-level client. #406

Added guide for using raw JSON REST requests with low-level client. #406

Conversation

Djcarrillo6 commented Oct 22, 2023

Description

Issues Resolved

dblock left a comment

Choose a reason for hiding this comment

Djcarrillo6 commented Oct 23, 2023 • edited Loading

dblock commented Oct 24, 2023

Djcarrillo6 commented Oct 25, 2023

dblock left a comment

Choose a reason for hiding this comment

Djcarrillo6 commented Oct 27, 2023

Xtansia left a comment

Choose a reason for hiding this comment

Djcarrillo6 commented Nov 2, 2023

Xtansia commented Nov 2, 2023

dblock left a comment

Choose a reason for hiding this comment

dblock Nov 3, 2023

Choose a reason for hiding this comment

Djcarrillo6 commented Nov 3, 2023

Xtansia left a comment

Choose a reason for hiding this comment

Djcarrillo6 commented Nov 12, 2023

dblock commented Nov 13, 2023

Djcarrillo6 commented Oct 23, 2023 •

edited

Loading