Skip to content

Update GET top N api documentation #8139

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Sep 11, 2024
Merged

Update GET top N api documentation #8139

merged 5 commits into from
Sep 11, 2024

Conversation

dzane17
Copy link
Member

@dzane17 dzane17 commented Aug 30, 2024 •
edited
Loading

Description

Clarify GET top N api documentation

Issues Resolved

Resolves opensearch-project/query-insights#80 & opensearch-project/query-insights#83

Version

2.15+

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@github-actions GitHub Actions
Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@dzane17
Copy link
Member Author

dzane17 commented Aug 30, 2024

@kolchfa-aws Ready for doc review. Thanks!

kolchfa-aws
kolchfa-aws reviewed Sep 4, 2024
View reviewed changes
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Thank you, @dzane17! Could you give a clarification to the "current time window"? Otherwise, looks good.

@dzane17
Copy link
Member Author

dzane17 commented Sep 4, 2024

@kolchfa-aws I've added your suggestion and included a link to "configuring window size" to clarify.

kolchfa-aws
kolchfa-aws approved these changes Sep 4, 2024
View reviewed changes
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thank you, @dzane17! LGTM. Applying "Done but waiting to merge" label to put this in the editorial queue starting 9/11.

@kolchfa-aws kolchfa-aws added Done but waiting to merge PR: The work is done and ready to merge Editorial review PR: Editorial review in progress release-notes PR: Include this PR in the automated release notes v2.17.0 backport 2.16 and removed v2.17.0 labels Sep 4, 2024
deshsidd
deshsidd reviewed Sep 4, 2024
View reviewed changes
deshsidd
deshsidd reviewed Sep 4, 2024
View reviewed changes
@dzane17
Copy link
Member Author

dzane17 commented Sep 5, 2024

@deshsidd @ansjcy Updated intro and added sentence about sorting by metric type

@ansjcy
Copy link
Member

ansjcy commented Sep 9, 2024

Thanks @dzane17 , the change looks good to me.

natebower
natebower reviewed Sep 11, 2024
View reviewed changes
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@dzane17 @kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!

kolchfa-aws
kolchfa-aws reviewed Sep 11, 2024
View reviewed changes
@kolchfa-aws kolchfa-aws merged commit 01e3069 into opensearch-project:main Sep 11, 2024
5 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Sep 11, 2024
@github-actions @kolchfa-aws @natebower
Update GET top N api documentation (#8139)
f72ba47 
* Update GET top N api documentation

Signed-off-by: David Zane <[email protected]>

* Update _observing-your-data/query-insights/top-n-queries.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: David Zane <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: David Zane <[email protected]>
Signed-off-by: David Zane <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit 01e3069)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Sep 11, 2024
Merged
github-actions bot pushed a commit that referenced this pull request Sep 11, 2024
@opensearch-trigger-bot
Update GET top N api documentation (#8139) (#8225)
c8be15e
@dzane17 dzane17 deleted the top-n branch September 11, 2024 20:30
epugh pushed a commit to o19s/documentation-website that referenced this pull request Sep 12, 2024
@dzane17 @kolchfa-aws
@natebower @epugh
Update GET top N api documentation (opensearch-project#8139)
061e686 
* Update GET top N api documentation

Signed-off-by: David Zane <[email protected]>

* Update _observing-your-data/query-insights/top-n-queries.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: David Zane <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: David Zane <[email protected]>
Signed-off-by: David Zane <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Eric Pugh <[email protected]>
noahstaveley pushed a commit to noahstaveley/documentation-website that referenced this pull request Sep 23, 2024
@dzane17 @kolchfa-aws
@natebower @noahstaveley
Update GET top N api documentation (opensearch-project#8139)
29432ad 
* Update GET top N api documentation

Signed-off-by: David Zane <[email protected]>

* Update _observing-your-data/query-insights/top-n-queries.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: David Zane <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: David Zane <[email protected]>
Signed-off-by: David Zane <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Noah Staveley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@natebower natebower natebower left review comments

@kolchfa-aws kolchfa-aws kolchfa-aws approved these changes

@Naarcha-AWS Naarcha-AWS Awaiting requested review from Naarcha-AWS

@vagimeli vagimeli Awaiting requested review from vagimeli

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

@dlvenable dlvenable Awaiting requested review from dlvenable dlvenable is a code owner

@stephen-crawford stephen-crawford Awaiting requested review from stephen-crawford

@epugh epugh Awaiting requested review from epugh epugh is a code owner

+2 more reviewers

@ansjcy ansjcy ansjcy approved these changes

@deshsidd deshsidd deshsidd approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@kolchfa-aws kolchfa-aws

Labels

backport 2.16 Done but waiting to merge PR: The work is done and ready to merge Editorial review PR: Editorial review in progress release-notes PR: Include this PR in the automated release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[BUG] type param not working as expected for the Top N queries API

5 participants

@dzane17 @ansjcy @deshsidd @natebower @kolchfa-aws