Adding documentation for _list APIs #8594

gargharsh3134 · 2024-10-22T04:53:27Z

Description

Adding documentation for newly introduced _list APIs.

Issues Resolved

Version

2.18 and onwards.

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.

Signed-off-by: Harsh Garg <gkharsh@amazon.com>

github-actions · 2024-10-22T04:53:40Z

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.

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

_api-reference/list/list-shards.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

_api-reference/list/list-shards.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Naarcha-AWS · 2024-10-28T22:16:30Z

@natebower: This is ready for editorial review.

natebower

@Naarcha-AWS @gargharsh3134 Please see my comments and changes and let me know if you have any questions. Thanks!

_api-reference/list/index.md

natebower · 2024-10-29T10:57:35Z

_api-reference/list/index.md

+
+## Examples
+
+The following examples show how to use the optional query parameters to customize the response of all List APIs.


"the response of all List APIs" => "all List API responses"?

_api-reference/list/index.md

natebower · 2024-10-29T11:24:03Z

_api-reference/list/list-shards.md

+`cluster_manager_timeout` | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
+`cancel_after_time_interval` | Time | The amount of time after which the shard request is canceled. Default is `-1` (no timeout).
+`time` | Time | Specifies the units for time, for example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
+`next_token` | String | Fetches the next page of indexes. When `null` provides the first page of indexes. Default is `null`. 


"Fetches the next page of indexes when null provides the first page of indexes"?

_api-reference/list/list-shards.md

_api-reference/list/index.md

_api-reference/list/list-indices.md

_api-reference/list/list-shards.md

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

_api-reference/list/list-indices.md

natebower · 2024-10-29T12:19:02Z

@Naarcha-AWS Please tag me for review of any added/modified text resulting from additional tech review comments. Thanks!

_api-reference/list/index.md

_api-reference/list/list-indices.md

_api-reference/list/list-shards.md

Signed-off-by: Harsh Garg <gkharsh@amazon.com>

_api-reference/list/list-indices.md

_api-reference/list/index.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

_api-reference/list/list-indices.md

_api-reference/list/list-shards.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Adding documentation for _list APIs Signed-off-by: Harsh Garg <gkharsh@amazon.com> * Add edits to index page. Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Add edits to list indices Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update list-shards.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update index.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Small grammar fixes Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _api-reference/list/list-indices.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _api-reference/list/list-shards.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Correcting the examples and limits for size parameter Signed-off-by: Harsh Garg <gkharsh@amazon.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update list-indices.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update list-shards.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Harsh Garg <gkharsh@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Harsh Garg <gkharsh@amazon.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>

Adding documentation for _list APIs

9039868

Signed-off-by: Harsh Garg <gkharsh@amazon.com>

github-actions bot assigned kolchfa-aws Oct 22, 2024

gargharsh3134 marked this pull request as ready for review October 22, 2024 10:02

gargharsh3134 requested review from AMoo-Miki, Naarcha-AWS, dlvenable, epugh, kolchfa-aws, natebower and vagimeli as code owners October 22, 2024 10:02

kolchfa-aws assigned Naarcha-AWS and unassigned kolchfa-aws Oct 22, 2024

kolchfa-aws added v2.18.0 release-notes PR: Include this PR in the automated release notes labels Oct 22, 2024

Naarcha-AWS added the Doc review PR: Doc review in progress label Oct 22, 2024

Naarcha-AWS added 4 commits October 28, 2024 12:49

Merge branch 'main' into listDocumentation

dc91ef6

Add edits to index page.

deeb1fc

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Add edits to list indices

5d52245

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Update list-shards.md

dba18da

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Naarcha-AWS reviewed Oct 28, 2024

View reviewed changes

_api-reference/list/list-shards.md Outdated Show resolved Hide resolved

Naarcha-AWS added 3 commits October 28, 2024 15:02

Update index.md

8e92c50

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Small grammar fixes

4bd2875

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Merge branch 'main' into listDocumentation

7a60ce9

gargharsh3134 mentioned this pull request Oct 28, 2024

[RFC] Paginating _cat APIs opensearch-project/OpenSearch#15013

Open

Naarcha-AWS reviewed Oct 28, 2024

View reviewed changes

_api-reference/list/list-shards.md Outdated Show resolved Hide resolved

Apply suggestions from code review

64168f8

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Naarcha-AWS added Editorial review PR: Editorial review in progress and removed Doc review PR: Doc review in progress labels Oct 28, 2024

Merge branch 'main' into listDocumentation

caf978f

Naarcha-AWS approved these changes Oct 28, 2024

View reviewed changes

natebower reviewed Oct 29, 2024

View reviewed changes

Naarcha-AWS reviewed Oct 29, 2024

View reviewed changes

_api-reference/list/index.md Outdated Show resolved Hide resolved

Naarcha-AWS reviewed Oct 29, 2024

View reviewed changes

_api-reference/list/index.md Outdated Show resolved Hide resolved

Naarcha-AWS reviewed Oct 29, 2024

View reviewed changes

_api-reference/list/list-indices.md Outdated Show resolved Hide resolved

Naarcha-AWS reviewed Oct 29, 2024

View reviewed changes

_api-reference/list/list-indices.md Outdated Show resolved Hide resolved

Naarcha-AWS reviewed Oct 29, 2024

View reviewed changes

_api-reference/list/list-shards.md Outdated Show resolved Hide resolved

Naarcha-AWS reviewed Oct 29, 2024

View reviewed changes

_api-reference/list/list-shards.md Outdated Show resolved Hide resolved

Naarcha-AWS and others added 3 commits October 29, 2024 06:45

Apply suggestions from code review

0b77b87

Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Update _api-reference/list/list-indices.md

1e890a2

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Update _api-reference/list/list-shards.md

8fef858

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

sumitasr reviewed Oct 29, 2024

View reviewed changes

_api-reference/list/list-indices.md Show resolved Hide resolved

sumitasr reviewed Oct 29, 2024

View reviewed changes

_api-reference/list/index.md Show resolved Hide resolved

sumitasr reviewed Oct 29, 2024

View reviewed changes

_api-reference/list/list-indices.md Outdated Show resolved Hide resolved

sumitasr reviewed Oct 29, 2024

View reviewed changes

_api-reference/list/list-shards.md Outdated Show resolved Hide resolved

Correcting the examples and limits for size parameter

b1989c1

Signed-off-by: Harsh Garg <gkharsh@amazon.com>

Naarcha-AWS reviewed Oct 29, 2024

View reviewed changes

_api-reference/list/list-indices.md Outdated Show resolved Hide resolved

Naarcha-AWS reviewed Oct 29, 2024

View reviewed changes

_api-reference/list/index.md Outdated Show resolved Hide resolved

Naarcha-AWS added 4 commits October 29, 2024 14:04

Apply suggestions from code review

f0a1ef7

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Update list-indices.md

b4658b9

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Update list-shards.md

65537ae

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Merge branch 'main' into listDocumentation

7f7cea5

Naarcha-AWS reviewed Oct 29, 2024

View reviewed changes

_api-reference/list/list-indices.md Outdated Show resolved Hide resolved

Naarcha-AWS reviewed Oct 29, 2024

View reviewed changes

_api-reference/list/list-shards.md Outdated Show resolved Hide resolved

Apply suggestions from code review

a47288a

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

Naarcha-AWS merged commit 60f74c4 into opensearch-project:main Oct 29, 2024
5 checks passed


		## Examples

		The following examples show how to use the optional query parameters to customize the response of all List APIs.

Adding documentation for _list APIs #8594

Adding documentation for _list APIs #8594

Uh oh!

Conversation

gargharsh3134 commented Oct 22, 2024 • edited by Naarcha-AWS Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issues Resolved

Version

Frontend features

Checklist

Uh oh!

github-actions bot commented Oct 22, 2024

Uh oh!

Uh oh!

Uh oh!

Naarcha-AWS commented Oct 28, 2024

Uh oh!

natebower left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

natebower Oct 29, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

natebower Oct 29, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

natebower commented Oct 29, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

gargharsh3134 commented Oct 22, 2024 •

edited by Naarcha-AWS

Loading