opensearch-project / OpenSearch-Dashboards

📊 Open source visualization dashboards for OpenSearch.
https://opensearch.org/docs/latest/dashboards/index/
Apache License 2.0
1.58k stars 796 forks source link

Add OpenAPI specification for get and create saved object APIs #6799

Closed BionIT closed 2 weeks ago

BionIT commented 2 weeks ago

Description

This change adds OpenAPI specification for get and create saved object APIs, and also added a readme with instructions about how to spin off swagger UI

Issues Resolved

Related to https://github.com/opensearch-project/OpenSearch-Dashboards/issues/6719

Screenshot

Below is after running npx serve locally in the folder where the yaml file is located Screenshot 2024-05-15 at 3 18 19 PM

Changelog

Check List

codecov[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 67.51%. Comparing base (293e1a5) to head (0c72d12).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #6799 +/- ## ========================================== - Coverage 67.55% 67.51% -0.05% ========================================== Files 3428 3428 Lines 67340 67340 Branches 10994 10994 ========================================== - Hits 45492 45465 -27 - Misses 19178 19199 +21 - Partials 2670 2676 +6 ``` | [Flag](https://app.codecov.io/gh/opensearch-project/OpenSearch-Dashboards/pull/6799/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=opensearch-project) | Coverage Δ | | |---|---|---| | [Linux_1](https://app.codecov.io/gh/opensearch-project/OpenSearch-Dashboards/pull/6799/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=opensearch-project) | `33.04% <ø> (ø)` | | | [Linux_2](https://app.codecov.io/gh/opensearch-project/OpenSearch-Dashboards/pull/6799/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=opensearch-project) | `55.13% <ø> (ø)` | | | [Linux_3](https://app.codecov.io/gh/opensearch-project/OpenSearch-Dashboards/pull/6799/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=opensearch-project) | `45.15% <ø> (-0.02%)` | :arrow_down: | | [Linux_4](https://app.codecov.io/gh/opensearch-project/OpenSearch-Dashboards/pull/6799/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=opensearch-project) | `34.73% <ø> (ø)` | | | [Windows_1](https://app.codecov.io/gh/opensearch-project/OpenSearch-Dashboards/pull/6799/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=opensearch-project) | `33.06% <ø> (ø)` | | | [Windows_2](https://app.codecov.io/gh/opensearch-project/OpenSearch-Dashboards/pull/6799/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=opensearch-project) | `?` | | | [Windows_3](https://app.codecov.io/gh/opensearch-project/OpenSearch-Dashboards/pull/6799/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=opensearch-project) | `?` | | | [Windows_4](https://app.codecov.io/gh/opensearch-project/OpenSearch-Dashboards/pull/6799/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=opensearch-project) | `?` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=opensearch-project#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.