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 update, delete and migrate saved object API #6864

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 update, delete and migrate saved object API.

Issues Resolved

Related to #6719

Screenshot

update
Screenshot 2024-05-30 at 11 10 39 AM

delete
Screenshot 2024-05-30 at 11 10 30 AM

migrate
Screenshot 2024-05-30 at 11 10 53 AM

Testing the changes

run npx serve and see the specification being used in swagger

Changelog

  • doc: Add OpenAPI specification for update, delete and migrate saved object API

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

… API

Signed-off-by: Lu Yu <nluyu@amazon.com>
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 (d665cf1).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6864      +/-   ##
==========================================
- Coverage   67.39%   67.38%   -0.02%     
==========================================
  Files        3443     3443              
  Lines       67797    67797              
  Branches    11033    11033              
==========================================
- Hits        45690    45683       -7     
- Misses      19439    19443       +4     
- Partials     2668     2671       +3     
Flag Coverage Δ
Linux_1 33.07% <ø> (ø)
Linux_2 55.12% <ø> (ø)
Linux_3 45.17% <ø> (-0.01%) ⬇️
Linux_4 ?
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.

@BionIT BionIT merged commit bfe0e14 into opensearch-project:main May 30, 2024
67 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request May 30, 2024
… API (#6864)

* add OpenAPI specification for update, delete and migrate saved object API

Signed-off-by: Lu Yu <nluyu@amazon.com>

* Changeset file for PR #6864 created/updated

---------

Signed-off-by: Lu Yu <nluyu@amazon.com>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
(cherry picked from commit bfe0e14)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
ZilongX pushed a commit that referenced this pull request May 30, 2024
… API (#6864) (#6866)

* add OpenAPI specification for update, delete and migrate saved object API



* Changeset file for PR #6864 created/updated

---------



(cherry picked from commit bfe0e14)

Signed-off-by: Lu Yu <nluyu@amazon.com>
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
… API (opensearch-project#6864)

* add OpenAPI specification for update, delete and migrate saved object API

Signed-off-by: Lu Yu <nluyu@amazon.com>

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

---------

Signed-off-by: Lu Yu <nluyu@amazon.com>
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