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

provide additional detail on swagger docs for insertMany #591

Merged
merged 1 commit into from
Oct 25, 2023

Conversation

jeffreyscarpenter
Copy link
Contributor

During testing some users have become confused by the behavior of the insertMany command with respect to how partial failure is handled. Users don't realize that setting the ordered option to false will allow them to bypass the default fail fast behavior, which returns on the first insert failure, even a failure as simple as inserting a duplicate _id.

Instead of referencing "specifications" that most users will not know how to find, this PR updates the swagger docs to pull in the detail from the spec.

Checklist

  • Changes manually tested
  • Automated Tests added/updated
  • Documentation added/updated
  • CLA Signed: DataStax CLA

@jeffreyscarpenter jeffreyscarpenter requested a review from a team as a code owner October 25, 2023 16:45
@jeffreyscarpenter
Copy link
Contributor Author

As far as I could tell, this was the only place in swagger docs that references the "specification" so hopefully we will not have other issues like this.

@tatu-at-datastax
Copy link
Contributor

Really good improvement, let's do it!

@jeffreyscarpenter jeffreyscarpenter merged commit 0dcf29b into main Oct 25, 2023
3 checks passed
@jeffreyscarpenter jeffreyscarpenter deleted the jeff/insert-many-documentation branch October 25, 2023 18:50
Copy link
Collaborator

@vkarpov15 vkarpov15 left a comment

Choose a reason for hiding this comment

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

LGTM 👍

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