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

Added documentation for cat?sort and format. #7619

Merged
merged 2 commits into from
Jul 3, 2024

Conversation

dblock
Copy link
Member

@dblock dblock commented Jul 2, 2024

Description

Coming from opensearch-project/opensearch-api-specification#373 addressing some misses in the cat API docs.

  • sort doesn't work, it's s
  • documented other formats, such as YAML, CBOR, and Smile

Please double-check for me since I don't know what I am doing :)

Version

2.14

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.

@kolchfa-aws kolchfa-aws self-assigned this Jul 3, 2024
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.

Thanks, @dblock!

_api-reference/cat/index.md Outdated Show resolved Hide resolved
_api-reference/cat/index.md Outdated Show resolved Hide resolved
_api-reference/cat/index.md Outdated Show resolved Hide resolved
_api-reference/cat/index.md Show resolved Hide resolved
_api-reference/cat/index.md Outdated Show resolved Hide resolved
_api-reference/cat/index.md Outdated Show resolved Hide resolved
_api-reference/cat/index.md Outdated Show resolved Hide resolved
_api-reference/cat/index.md Outdated Show resolved Hide resolved
_api-reference/cat/index.md Outdated Show resolved Hide resolved
_api-reference/cat/index.md Show resolved Hide resolved
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.

@dblock @kolchfa-aws No changes 😄. LGTM

@kolchfa-aws kolchfa-aws merged commit 94a9626 into opensearch-project:main Jul 3, 2024
6 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 3, 2024
* Added documentation for cat?sort and format.

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

* Apply suggestions from code review

Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: dblock <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
(cherry picked from commit 94a9626)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
leanneeliatra pushed a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Jul 24, 2024
* Added documentation for cat?sort and format.

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

* Apply suggestions from code review

Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: dblock <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: [email protected] <[email protected]>
sandervandegeijn pushed a commit to sandervandegeijn/documentation-website that referenced this pull request Jul 30, 2024
* Added documentation for cat?sort and format.

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

* Apply suggestions from code review

Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: dblock <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Sander van de Geijn <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants