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

Add OpenAPI specification for bulk create and bulk update saved object APIs #6859

Merged
merged 2 commits into from
May 30, 2024

Conversation

BionIT
Copy link
Collaborator

@BionIT BionIT commented May 30, 2024

Description

This change adds OpenAPI specification for bulk create and bulk update saved object APIs.

Issues Resolved

Related to #6719

Screenshot

bulk create
Screenshot 2024-05-29 at 8 12 34 PM

bulk update
Screenshot 2024-05-29 at 8 12 45 PM

Testing the changes

run npx serve and verify the api via swagger UI

Changelog

  • doc: Add OpenAPI specification for bulk create and bulk update saved object APIs

Check List

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

Copy link

codecov bot commented May 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.38%. Comparing base (026dd38) to head (cb5dc73).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6859   +/-   ##
=======================================
  Coverage   67.38%   67.38%           
=======================================
  Files        3443     3443           
  Lines       67797    67797           
  Branches    11033    11033           
=======================================
+ Hits        45683    45688    +5     
+ Misses      19443    19440    -3     
+ Partials     2671     2669    -2     
Flag Coverage Δ
Linux_1 33.07% <ø> (ø)
Linux_2 55.12% <ø> (ø)
Linux_3 45.18% <ø> (?)
Linux_4 34.82% <ø> (?)
Windows_1 33.09% <ø> (ø)
Windows_2 55.09% <ø> (ø)
Windows_3 45.19% <ø> (ø)
Windows_4 34.82% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@zhyuanqi zhyuanqi added docs Improvements or additions to documentation backport 2.x v2.15.0 and removed all-star-contributor labels May 30, 2024
@BionIT BionIT merged commit cf4e496 into opensearch-project:main May 30, 2024
74 checks passed
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-6859-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 cf4e496aa03d12b18244f271185863f5fbf1ff6d
# Push it to GitHub
git push --set-upstream origin backport/backport-6859-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-6859-to-2.x.

opensearch-trigger-bot bot pushed a commit that referenced this pull request May 30, 2024
…t APIs (#6859)

* ad doc for bulk create and bulk update

Signed-off-by: Lu Yu <[email protected]>

* Changeset file for PR #6859 created/updated

---------

Signed-off-by: Lu Yu <[email protected]>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
(cherry picked from commit cf4e496)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
BionIT pushed a commit that referenced this pull request May 30, 2024
…t APIs (#6859) (#6863)

* ad doc for bulk create and bulk update



* Changeset file for PR #6859 created/updated

---------



(cherry picked from commit cf4e496)

Signed-off-by: Lu Yu <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
LDrago27 pushed a commit to LDrago27/OpenSearch-Dashboards that referenced this pull request Jun 3, 2024
…t APIs (opensearch-project#6859)

* ad doc for bulk create and bulk update

Signed-off-by: Lu Yu <[email protected]>

* Changeset file for PR opensearch-project#6859 created/updated

---------

Signed-off-by: Lu Yu <[email protected]>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x docs Improvements or additions to documentation v2.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants