Skip to content

Conversation

hainenber
Copy link
Contributor

Description

Describe what this change achieves.
The sample ecommerce data file is not JSON per se but actually is [NDJSON](https://github.com/ndjson/ndjson-spec?tab=readme-ov-file) as suggested by the accompanying Content-Type header.

This PR is to remediate it.

Issues Resolved

Closes #[insert issue number]
N/A

Version

List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.
All

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
N/A

Checklist

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

Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@kolchfa-aws
Copy link
Collaborator

@peterzhuamazon Could you please review this PR?

@kolchfa-aws kolchfa-aws added the backport 2.17 Backport for version 2.17 label Sep 23, 2024
@kolchfa-aws
Copy link
Collaborator

@mgodwan Could you please review this PR?

@mgodwan
Copy link
Member

mgodwan commented Sep 30, 2024

@hainenber
Thanks for making the change to ensure the file's naming/content-type adhere to specification. I agree with the overall change.

For my understanding, this is mostly around representation, or did you also experience issues while following this guide due to mismatch of content-type and actual file spec?

1. Define the field mappings provided in the mapping file:
```bash
curl -H "Content-Type: application/x-ndjson" -X PUT "https://localhost:9200/ecommerce" -ku admin:<custom-admin-password> --data-binary "@ecommerce-field_mappings.json"
curl -H "Content-Type: application/json" -X PUT "https://localhost:9200/ecommerce" -ku admin:<custom-admin-password> --data-binary "@ecommerce-field_mappings.json"
Copy link
Member

Choose a reason for hiding this comment

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

Thanks for catching this!

@hainenber
Copy link
Contributor Author

Thanks for the review @mgodwan

It is only for representation. I've got no issue running the old cuủls.

Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Thank you, @hainenber! And thank you @mgodwan for the review. Ready to merge.

@kolchfa-aws kolchfa-aws merged commit 4bb49d3 into opensearch-project:main Sep 30, 2024
5 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Sep 30, 2024
Signed-off-by: hainenber <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
(cherry picked from commit 4bb49d3)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@hainenber hainenber deleted the correct-json-extension-for-sample-ingest-data branch October 1, 2024 01:48
leanneeliatra pushed a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Oct 9, 2024
leanneeliatra pushed a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Oct 9, 2024
leanneeliatra pushed a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport 2.17 Backport for version 2.17

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants