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 doc for saved_object find api #6856

Merged
merged 2 commits into from
May 29, 2024

Conversation

zhyuanqi
Copy link
Collaborator

@zhyuanqi zhyuanqi commented May 29, 2024

Description

Add openAPI doc for saved_object find api

Issues Resolved

#6719

Screenshot

Screenshot 2024-05-29 at 2 56 19 PM Screenshot 2024-05-29 at 2 56 25 PM

Changelog

  • doc: Add openAPI doc for saved_object find 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

@opensearch-project opensearch-project deleted a comment from github-actions bot May 29, 2024
@zhyuanqi zhyuanqi added docs Improvements or additions to documentation backport 2.x v2.15.0 and removed seasoned-contributor labels May 29, 2024
Copy link

codecov bot commented May 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.38%. Comparing base (089a2de) to head (af76080).

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           
Flag Coverage Δ
Linux_1 33.07% <ø> (ø)
Linux_2 55.12% <ø> (ø)
Linux_3 45.17% <ø> (?)
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.

Comment on lines +173 to +176
description: The search query that filters the saved objects.
schema:
type: string
example: "open*"
Copy link
Member

Choose a reason for hiding this comment

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

is there a specified syntax for the search query? e.g. is it just glob

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Will update the description here

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Will update the description in the next PR

@zhyuanqi zhyuanqi merged commit 026dd38 into opensearch-project:main May 29, 2024
75 checks passed
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 <[email protected]>

* Changeset file for PR #6856 created/updated

---------

Signed-off-by: Yuanqi(Ella) Zhu <[email protected]>
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 <[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
* Add openAPI doc for saved_object find api

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

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

---------

Signed-off-by: Yuanqi(Ella) Zhu <[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.

4 participants