Skip to content
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 bulk api docs to getting_started #187

Merged
merged 4 commits into from
Aug 26, 2022

Conversation

harshavamsi
Copy link
Collaborator

@harshavamsi harshavamsi commented Aug 18, 2022

Signed-off-by: Harsha Vamsi Kalluri [email protected]

Description
Adds examples on how to use bulk api through client and helpers.

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

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.

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
@harshavamsi harshavamsi requested review from a team, axeoman and deztructor as code owners August 18, 2022 18:34
Copy link
Collaborator

@VachaShah VachaShah left a comment

Choose a reason for hiding this comment

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

Lets also add a description to the PR according to the PR template?

.gitignore Outdated Show resolved Hide resolved
.gitignore Outdated
@@ -142,3 +142,10 @@ cython_debug/
test_opensearch/cover
test_opensearch/local.py
.ci/output

# Local test file
Copy link
Collaborator

Choose a reason for hiding this comment

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

Are these generated files or just something for your local testing?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yep, adding some local files for testing. These are just gitignored.

Copy link
Collaborator

Choose a reason for hiding this comment

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

No I meant since this is not part of repo, lets not add them here as they are for local testing.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Removed.

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
@harshavamsi harshavamsi requested a review from VachaShah August 18, 2022 22:35
client.bulk(docs)


# Bulk index documents using the helper function
Copy link
Member

Choose a reason for hiding this comment

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

Consider breaking up the samples into sections with their own code blocks?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@dblock separated the docs, wdyt?

Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

I'd prefer for Titles to Be Capitalized Like This, but this is totally personal, this looks great! :)

@VachaShah VachaShah merged commit 382f63e into opensearch-project:main Aug 26, 2022
@harshavamsi harshavamsi deleted the harshavamsi/issue173 branch August 31, 2022 23:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants