Add openAPI doc for saved_object find api #6856
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>
zhyuanqi
requested review from
ananzh,
kavilla,
AMoo-Miki,
ashwin-pc,
joshuarrrr,
abbyhu2000,
zengyan-amazon,
zhongnansu,
manasvinibs,
ZilongX,
Flyingliuhub,
curq,
bandinib-amzn,
SuZhou-Joe,
ruanyl,
BionIT,
xinruiba and
mengweieric
as code owners
zhyuanqi
added
docs
BionIT
approved these changes
May 29, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6856 +/- ##
=======================================
Coverage 67.38% 67.38%
=======================================
Files 3443 3443
Lines 67797 67797
Branches 11033 11033
=======================================
Hits 45688 45688
Misses 19440 19440
Partials 2669 2669
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
zhongnansu
approved these changes
May 29, 2024
joshuali925
reviewed
May 29, 2024
Comment on lines
+173
to
+176
| description: The search query that filters the saved objects. | ||
| schema: | ||
| type: string | ||
| example: "open*" |
There was a problem hiding this comment.
is there a specified syntax for the search query? e.g. is it just glob
There was a problem hiding this comment.
It uses simple_query_string query that filters the objects in the response. The syntax is quite simple
+ signifies AND operation
| signifies OR operation
- negates a single token
" wraps a number of tokens to signify a phrase for searching
* at the end of a term signifies a prefix query
( and ) signify precedence
~N after a word signifies edit distance (fuzziness)
~N after a phrase signifies slop amount
There was a problem hiding this comment.
Will update the description here
There was a problem hiding this comment.
Will update the description in the next PR
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
May 29, 2024
* Add openAPI doc for saved_object find api Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * Changeset file for PR #6856 created/updated --------- Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> (cherry picked from commit 026dd38) 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 doc for saved_object find api * Changeset file for PR #6856 created/updated --------- (cherry picked from commit 026dd38) Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@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>
45 tasks
LDrago27
pushed a commit
to LDrago27/OpenSearch-Dashboards
that referenced
this pull request
Jun 3, 2024
* Add openAPI doc for saved_object find api Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com> * Changeset file for PR opensearch-project#6856 created/updated --------- Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add openAPI doc for saved_object find api
Issues Resolved
#6719
Screenshot
Changelog
Check List
yarn test:jestyarn test:jest_integration