opensearch-project / opensearch-js

Node.js Client for OpenSearch
https://opensearch.org/docs/latest/clients/javascript/
Apache License 2.0
177 stars 116 forks source link

Add missing items to the response body in guides/bulk.md #712

Closed ap-h closed 2 months ago

ap-h commented 4 months ago

Description

Describe what this change achieves.

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

Check List

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 commented 4 months ago

We had similar problems in guides, so we started adding working samples into https://github.com/opensearch-project/opensearch-js/tree/main/samples. Do you want to extract this code into a working sample and reference it? This way we know the code works 100%.

ap-h commented 4 months ago

We had similar problems in guides, so we started adding working samples into https://github.com/opensearch-project/opensearch-js/tree/main/samples. Do you want to extract this code into a working sample and reference it? This way we know the code works 100%.

Thanks for the review, yep I think I can do this over the weekend, do you know any example how samples added to the guides? Just for wordings

dblock commented 4 months ago

We had similar problems in guides, so we started adding working samples into https://github.com/opensearch-project/opensearch-js/tree/main/samples. Do you want to extract this code into a working sample and reference it? This way we know the code works 100%.

Thanks for the review, yep I think I can do this over the weekend, do you know any example how samples added to the guides? Just for wordings

It's all over the place, e.g. https://github.com/opensearch-project/opensearch-js/blob/4e615f3d38bfc149fd94d3009ca824b4f6a3b862/guides/search.md#search references a sample file. I am happy with anything that links to it.

Someone will go edit all the docs, write all the samples, and make it awesome. Wink wink :)

nhtruong commented 4 months ago

The guide has been reworked. Please check if this change is still needed anymore or if you wanna make other updates to it :)

ap-h commented 2 months ago

Thanks @nhtruong, I don't think this is needed anymore.