-
Notifications
You must be signed in to change notification settings - Fork 107
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding a guide for making raw json requests using the client #399
Conversation
This code is tested against OpenSearch cluster. |
9734a1f
to
3a05262
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Can we add a runnable sample along with this?
Not 100% sure what you mean with that. |
Signed-off-by: Vacha Shah <vachshah@amazon.com>
Signed-off-by: Vacha Shah <vachshah@amazon.com>
3a05262
to
bc8d1c1
Compare
We had a lot of contributions where code didn't work when copy-pasted, so in other clients we started adding samples that users can "just run", e.g. https://github.com/opensearch-project/opensearch-py/tree/main/samples. WDYT? |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #399 +/- ##
=======================================
Coverage 57.25% 57.25%
=======================================
Files 315 315
Lines 9820 9820
=======================================
Hits 5622 5622
Misses 2904 2904
Partials 1294 1294
Flags with carried forward coverage won't be shown. Click here to find out more. |
Added samples for all guids, as I already had them when I updated the guids. Once this is merge we could replace the code blocks of the guids with permanent links to the files instead of copy paste the code? |
Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com>
b1f5800
to
2e78c3d
Compare
You could, but other clients don't really do that. I see guides kept to something concise and copy-pasted and working samples. Ideally samples should be compiled and run as integration tests and guide reference code, of course, but that needs tools. |
We forgot to link json.md from USER_GUIDE. Maybe in a future PR? |
Description
Same as title
Issues Resolved
Closes #395
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.