Skip to content

[DOCS] Remove cat anomaly detectors enum values via overlay #4441

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 1 commit into from
Jun 4, 2025
Merged

[DOCS] Remove cat anomaly detectors enum values via overlay #4441

merged 1 commit into from
Jun 4, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jun 3, 2025

Relates to #4345
In particular, relates to the following caveat from #4313

Caveat: for unary values (i.e. not an array or lenient array), bump.sh will still render its list below the descriptions added by this PR. This could be avoided by removing the enumeration values from the OpenAPI spec...

This PR tests that suggestion for the following cat API: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs

Preview

Before

Redundant list exists (though collapsed by default):

image

After

Redundant list is removed:

image

@lcawl lcawl requested review from georgewallace and szabosteve June 3, 2025 00:10
@lcawl lcawl marked this pull request as ready for review June 3, 2025 00:10
@lcawl lcawl added the OpenAPI label Jun 3, 2025
szabosteve
szabosteve approved these changes Jun 3, 2025
View reviewed changes
Copy link
Contributor

@szabosteve szabosteve 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 ba32be2 into main Jun 4, 2025
18 checks passed
@lcawl lcawl deleted the cat-enums branch June 4, 2025 23:42
github-actions bot pushed a commit that referenced this pull request Jun 4, 2025
@lcawl @github-actions
[DOCS] Remove cat anomaly detectors enum values via overlay (#4441)
836d1ce 
(cherry picked from commit ba32be2)
@github-actions github-actions bot mentioned this pull request Jun 4, 2025
Merged
github-actions bot pushed a commit that referenced this pull request Jun 4, 2025
@lcawl @github-actions
[DOCS] Remove cat anomaly detectors enum values via overlay (#4441)
c9c35da 
(cherry picked from commit ba32be2)
github-actions bot pushed a commit that referenced this pull request Jun 4, 2025
@lcawl @github-actions
[DOCS] Remove cat anomaly detectors enum values via overlay (#4441)
704d54e 
(cherry picked from commit ba32be2)
This was referenced Jun 4, 2025
Merged
Merged
lcawl added a commit that referenced this pull request Jun 4, 2025
@github-actions @lcawl
[DOCS] Remove cat anomaly detectors enum values via overlay (#4441) (#…
588baed 
…4457)

(cherry picked from commit ba32be2)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
lcawl added a commit that referenced this pull request Jun 4, 2025
@github-actions @lcawl
[DOCS] Remove cat anomaly detectors enum values via overlay (#4441) (#…
99728b2 
…4455)

(cherry picked from commit ba32be2)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
lcawl added a commit that referenced this pull request Jun 4, 2025
@github-actions @lcawl
[DOCS] Remove cat anomaly detectors enum values via overlay (#4441) (#…
acc827a 
…4456)

(cherry picked from commit ba32be2)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@lcawl lcawl mentioned this pull request Jun 5, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@szabosteve szabosteve szabosteve approved these changes

@georgewallace georgewallace Awaiting requested review from georgewallace

Assignees
No one assigned
Labels
backport 8.18 backport 8.19 backport 9.0 documentation OpenAPI
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lcawl @szabosteve