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_get saved object APIs #6860

Merged
merged 3 commits into from
May 30, 2024

Conversation

zhyuanqi
Copy link
Collaborator

Description

Add OpenAPI specification for bulk_get saved object APIs

Issues Resolved

#6719

Screenshot

Screenshot 2024-05-29 at 10 33 48 PM

Changelog

  • doc: Add OpenAPI specification for bulk_get 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

@zhyuanqi zhyuanqi added backport 1.3 v2.15.0 docs Improvements or additions to documentation and removed seasoned-contributor labels May 30, 2024
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 (cf4e496) to head (a3e53ac).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6860      +/-   ##
==========================================
- Coverage   67.39%   67.38%   -0.01%     
==========================================
  Files        3443     3443              
  Lines       67797    67797              
  Branches    11033    11033              
==========================================
- Hits        45690    45688       -2     
- Misses      19439    19440       +1     
- Partials     2668     2669       +1     
Flag Coverage Δ
Linux_1 33.07% <ø> (ø)
Linux_2 55.12% <ø> (ø)
Linux_3 45.18% <ø> (+<0.01%) ⬆️
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.

zhongnansu
zhongnansu previously approved these changes May 30, 2024
summary: Bulk get saved objects
requestBody:
required: true
description: Array of saved objects to update
Copy link
Collaborator

Choose a reason for hiding this comment

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

To update or to retrieve? The array is search criteria, right?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

THanks for pointing this out. Will make the change

Co-authored-by: Lu Yu <[email protected]>
Signed-off-by: Yuanqi(Ella) Zhu <[email protected]>
@zhyuanqi zhyuanqi merged commit 6b2db4d into opensearch-project:main May 30, 2024
69 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request May 30, 2024
* Add OpenAPI specification for bulk_get saved object APIs

Signed-off-by: Yuanqi(Ella) Zhu <[email protected]>

* Changeset file for PR #6860 created/updated

* Apply suggestions from code review

Co-authored-by: Lu Yu <[email protected]>
Signed-off-by: Yuanqi(Ella) Zhu <[email protected]>

---------

Signed-off-by: Yuanqi(Ella) Zhu <[email protected]>
Signed-off-by: Yuanqi(Ella) Zhu <[email protected]>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
Co-authored-by: Lu Yu <[email protected]>
(cherry picked from commit 6b2db4d)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
zhyuanqi pushed a commit that referenced this pull request May 30, 2024
* Add OpenAPI specification for bulk_get saved object APIs



* Changeset file for PR #6860 created/updated

* Apply suggestions from code review




---------





(cherry picked from commit 6b2db4d)

Signed-off-by: Yuanqi(Ella) Zhu <[email protected]>
Signed-off-by: Yuanqi(Ella) Zhu <[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>
Co-authored-by: Lu Yu <[email protected]>
LDrago27 pushed a commit to LDrago27/OpenSearch-Dashboards that referenced this pull request Jun 3, 2024
…project#6860)

* Add OpenAPI specification for bulk_get saved object APIs

Signed-off-by: Yuanqi(Ella) Zhu <[email protected]>

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

* Apply suggestions from code review

Co-authored-by: Lu Yu <[email protected]>
Signed-off-by: Yuanqi(Ella) Zhu <[email protected]>

---------

Signed-off-by: Yuanqi(Ella) Zhu <[email protected]>
Signed-off-by: Yuanqi(Ella) Zhu <[email protected]>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
Co-authored-by: Lu Yu <[email protected]>
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