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

Add asynchronous search descriptions. #781

Merged

Tokesh merged 3 commits into opensearch-project:main from Naarcha-AWS:ref-description-test

Jan 13, 2025

Contributor

Naarcha-AWS commented Jan 10, 2025

Updates the query parameter descriptions for asynchronous search API.

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


          Add asynchronous search descriptions.

6e467f7

Signed-off-by: Archer <[email protected]>

Naarcha-AWS requested review from dblock, harshavamsi, sachetalva, nhtruong, Xtansia, VachaShah, Tokesh and aabeshov as code owners

January 10, 2025 18:21

Contributor

github-actions bot commented Jan 10, 2025 •

edited

Loading

Changes Analysis

Commit SHA: cd09c98
Comparing To SHA: f021351

API Changes

Summary

└─┬Paths
  ├─┬/_plugins/_asynchronous_search/stats
  │ └─┬GET
  │   └──[🔀] description (3707:20)
  ├─┬/_plugins/_asynchronous_search/{id}
  │ ├─┬GET
  │ │ └──[🔀] description (3689:20)
  │ └─┬DELETE
  │   └──[🔀] description (3672:20)
  ├─┬/_opendistro/_asynchronous_search/{id}
  │ ├─┬GET
  │ │ └──[🔀] description (13174:20)
  │ └─┬DELETE
  │   └──[🔀] description (13193:20)
  ├─┬/_plugins/_asynchronous_search
  │ └─┬POST
  │   ├──[🔀] description (3649:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15644:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15650:20)
  │   └─┬Parameters
  │     └──[🔀] description (15635:20)
  ├─┬/_opendistro/_asynchronous_search
  │ └─┬POST
  │   ├──[🔀] description (13130:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15635:20)
  │   ├─┬Parameters
  │   │ └──[🔀] description (15644:20)
  │   └─┬Parameters
  │     └──[🔀] description (15650:20)
  └─┬/_opendistro/_asynchronous_search/stats
    └─┬GET
      └──[🔀] description (13155:20)

Document Element	Total Changes	Breaking Changes
paths	14	0

Total Changes: 14
Modifications: 14

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/12715319318/artifacts/2414636143

API Coverage

	Before	After	Δ
Covered (%)	643 (62.98 %)	643 (62.98 %)	0 (0 %)
Uncovered (%)	378 (37.02 %)	378 (37.02 %)	0 (0 %)
Unknown	43	43	0

Contributor

github-actions bot commented Jan 10, 2025

Spec Test Coverage Analysis

Total	Tested
573	570 (99.48 %)

natebower reviewed

View reviewed changes

Contributor

natebower left a comment

@Naarcha-AWS A couple changes. Thanks!

spec/namespaces/asynchronous_search.yaml Outdated Show resolved Hide resolved

spec/namespaces/asynchronous_search.yaml Outdated Show resolved Hide resolved

Naarcha-AWS mentioned this pull request

Update query parameter descriptions #780

Open

27 tasks

Naarcha-AWS and others added 2 commits

January 10, 2025 12:39


          Apply suggestions from code review

2ee36bd

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>


          Streamline formatting.

cd09c98

Signed-off-by: Archer <[email protected]>

Tokesh approved these changes

View reviewed changes

Tokesh added the skip-changelog label

Tokesh merged commit bf353a7 into opensearch-project:main

30 of 31 checks passed

natebower reviewed

View reviewed changes

Contributor

natebower left a comment

@Naarcha-AWS Please see my comments. Thanks!

spec/namespaces/asynchronous_search.yaml

    
            @@ -52,7 +52,7 @@ paths:
          
                    operationId: asynchronous_search.stats.0

                    x-operation-group: asynchronous_search.stats

                    x-version-added: '1.0'

                    description: Monitoring of asynchronous searches that are running, completed, and/or persisted.

                    description: Monitors any asynchronous searches that are `running`, `completed`, `persisted`.

Contributor

natebower Jan 23, 2025

Insert "or" prior to persisted.

spec/namespaces/asynchronous_search.yaml

@@ @@ -64,19 +64,22 @@ components: @@
                   asynchronous_search.search::query.wait_for_completion_timeout:
                     name: wait_for_completion_timeout
                     in: query
-                    description: The amount of time that you plan to wait for the results. You can poll the remaining results based on an ID. The maximum value is `300s`. Default is `1s`.
+                    description: The amount of time that you plan to wait for the results. You can poll the remaining results based on an ID. The maximum value is 300 seconds. Default is `1s`.

Contributor

natebower Jan 23, 2025

"The amount of time to wait for the results." Remove "that you plan".

spec/namespaces/asynchronous_search.yaml

                     schema:
                       type: string
                   asynchronous_search.search::query.keep_on_completion:
                     name: keep_on_completion
                     in: query
-                    description: Whether you want to save the results in the cluster after the search is complete.
+                    description: Whether you want to save the results in the cluster after the search is complete. You can examine the stored results at a later time.

Contributor

natebower Jan 23, 2025

Remove "you want".

spec/namespaces/asynchronous_search.yaml

+                    description: |-
+                      The amount of time that the result is saved in the cluster. For example, `2d` means that the results are stored in the cluster for 48 hours.
+                      The saved search results are deleted after this period or if the search is canceled. Note that this includes the query execution time.
+                      If the query overruns this time, the process cancels this query automatically.

Contributor

natebower Jan 23, 2025

"overruns this time" => "exceeds this amount of time"

This was referenced Jan 24, 2025

Add editorial comments to async search descriptions Naarcha-AWS/opensearch-api-specification#1

Closed

Async search editorial #807

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

natebower natebower left review comments

Tokesh Tokesh approved these changes

dblock Awaiting requested review from dblock dblock is a code owner

harshavamsi Awaiting requested review from harshavamsi harshavamsi is a code owner

sachetalva Awaiting requested review from sachetalva sachetalva is a code owner

nhtruong Awaiting requested review from nhtruong nhtruong is a code owner

Xtansia Awaiting requested review from Xtansia Xtansia is a code owner

VachaShah Awaiting requested review from VachaShah VachaShah is a code owner

aabeshov Awaiting requested review from aabeshov aabeshov is a code owner

Labels