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

[DOCS] Convert cat API examples to json format #4082

Merged
merged 4 commits into from
Mar 25, 2025
Merged

[DOCS] Convert cat API examples to json format #4082

merged 4 commits into from
Mar 25, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Mar 25, 2025

Relates to #4081

This PR updates the cat API examples to use the formt=json query parameter, since they were using the default text string format, which wasn't being correctly represented in the OpenAPI output.

@lcawl lcawl requested a review from a team March 25, 2025 01:33
@lcawl lcawl marked this pull request as ready for review March 25, 2025 01:33
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
cat.aliases 🟢 29/29 29/29
cat.allocation 🟢 12/12 12/12
cat.component_templates 🟢 3/3 3/3
cat.count 🟢 9/9 9/9
cat.fielddata 🟢 6/6 6/6
cat.health 🟢 3/3 3/3
cat.indices 🟢 33/33 32/32
cat.master 🟢 1/1 1/1
cat.ml_data_frame_analytics 🟢 5/5 5/5
cat.ml_datafeeds 🟢 4/4 4/4
cat.ml_jobs 🟢 4/4 4/4
cat.ml_trained_models 🟢 1/1 1/1
cat.nodeattrs 🟢 5/5 5/5
cat.nodes 🟢 11/11 11/11
cat.pending_tasks 🟢 1/1 1/1
cat.plugins 🟢 2/2 2/2
cat.recovery 🟢 6/6 6/6
cat.repositories 🟢 6/6 6/6
cat.segments 🟢 9/9 9/9
cat.shards 🟢 11/11 11/11
cat.snapshots 🟢 4/4 4/4
cat.tasks 🟢 11/11 11/11
cat.templates 🟢 17/17 17/17
cat.thread_pool 🟢 9/9 9/9

You can validate these APIs yourself by using the make validate target.

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
cat.aliases 🟢 29/29 29/29
cat.allocation 🟢 12/12 12/12
cat.component_templates 🟢 3/3 3/3
cat.count 🟢 9/9 9/9
cat.fielddata 🟢 6/6 6/6
cat.health 🟢 3/3 3/3
cat.indices 🟢 33/33 32/32
cat.master 🟢 1/1 1/1
cat.ml_data_frame_analytics 🟢 5/5 5/5
cat.ml_datafeeds 🟢 4/4 4/4
cat.ml_jobs 🟢 4/4 4/4
cat.ml_trained_models 🟢 1/1 1/1
cat.nodeattrs 🟢 5/5 5/5
cat.nodes 🟢 11/11 11/11
cat.pending_tasks 🟢 1/1 1/1
cat.plugins 🟢 2/2 2/2
cat.recovery 🟢 6/6 6/6
cat.repositories 🟢 6/6 6/6
cat.segments 🟢 9/9 9/9
cat.shards 🟢 11/11 11/11
cat.snapshots 🟢 4/4 4/4
cat.tasks 🟢 11/11 11/11
cat.templates 🟢 17/17 17/17
cat.thread_pool 🟢 9/9 9/9

You can validate these APIs yourself by using the make validate target.

Copy link

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM! 🍾

@lcawl lcawl merged commit 6c0a8fd into main Mar 25, 2025
8 checks passed
@lcawl lcawl deleted the cat-examples2 branch March 25, 2025 21:41
github-actions bot pushed a commit that referenced this pull request Mar 25, 2025
github-actions bot pushed a commit that referenced this pull request Mar 25, 2025
github-actions bot pushed a commit that referenced this pull request Mar 25, 2025
lcawl added a commit that referenced this pull request Mar 25, 2025
(cherry picked from commit 6c0a8fd)

Co-authored-by: Lisa Cawley <[email protected]>
lcawl added a commit that referenced this pull request Mar 25, 2025
(cherry picked from commit 6c0a8fd)

Co-authored-by: Lisa Cawley <[email protected]>
lcawl added a commit that referenced this pull request Mar 25, 2025
(cherry picked from commit 6c0a8fd)

Co-authored-by: Lisa Cawley <[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.

2 participants