CAT API automation (Part II)

[Naarcha-AWS]

This PR also fixes the previous automation markers with the latest changes to spec-insert tool..

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.

[github-actions]

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.

[kolchfa-aws]

The addition of the default column results in incorrect formatting.

[kolchfa-aws]

The "Default" column is not populated for some rows so the table is not displayed correctly (in all these files).

Also, since the table is automatically generated, could we have consistency in pipe symbols: either no pipe symbols on either end of the row, or pipe symbols on both ends of the row (the latter is more extensible).

[Naarcha-AWS]

It makes sense to add |'s at the end and the beginning to me. @nhtruong, would that be difficult to change in the workflow?

The pretty setting will add pipes but also add additional spacing. One solution is we could enable that by default, since the tables aren't going to be touched directly anyways.

[kolchfa-aws]

I would just add pipe symbols regardless of pretty. Also, there should be no empty cells in the table. Where there is no default, we should add N/A. However, it's strange that there was no default automatically provided for expand_wildcards. Is it missing from the spec?

[nhtruong]

It's not difficult. Are you saying with pretty: false (the default), the pipes are never present and with pretty: true they are there? OR are you saying that with pretty: false the pipes are there sometimes (this inconsistency would be a bug)

[nhtruong]

Regarding Default values not showing: Are they on the spec but not in the generated tables?

[kolchfa-aws]

I would go with adding pipes at the ends in any case (for pretty either true or false). This way, all tables are consistent (have pipes at either end at all times).

[Naarcha-AWS]

Right now, according to the expected output, pretty: true does include pipes at the end and the beginning.

[kolchfa-aws]

A couple of things here:

1. Please ensure that all descriptions for the same parameters are the same, as we discussed previously.
2. The <br> tag does not have a closing counterpart. Please use <br> everywhere. Currently, tables are not displayed properly:
   

[kolchfa-aws]

Suggested change

| `expand_wildcards` | List or String | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. <br> Valid values are: <br> - `all`: Match any index, including hidden ones. </br> - `closed`: Match closed, non-hidden indexes. </br> - `hidden`: Match hidden indexes. Must be combined with open, closed, or both. </br> - `none`: Wildcard expressions are not accepted. </br> - `open`: Match open, non-hidden indexes. | N/A |

| `expand_wildcards` | List or String | Specifies the type of index that wildcard expressions can match. Supports comma-separated values. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. <br> Valid values are: <br> - `all`: Match any index, including hidden ones. </br> - `closed`: Match closed, non-hidden indexes. </br> - `hidden`: Match hidden indexes. Must be combined with `open`, `closed`, or both. </br> - `none`: Wildcard expressions are not accepted. </br> - `open`: Match open, non-hidden indexes. | N/A |

[Naarcha-AWS]

Fixed.

[kolchfa-aws]

The descriptions for expand_wildcards should be the same for all these files.

[Naarcha-AWS]

This will get updated in the spec in a separate PR.

[Naarcha-AWS]

@kolchfa-aws: I addressed the tags issue. As far as the description consistency, that needs to be addressed in the spec and not here. The descriptions are grammatically and technically correct, and while yes, we need to address their consistency, that should not be a blocker to getting this PR merged.

[kolchfa-aws]

Absolutely - this needs to be addressed in the spec. In my view, it's a prerequisite to this PR. That way, we can avoid duplicated content:

Specifies the type of index that wildcard expressions can match. Supports comma-separated values. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. <br> Valid values are:

I presume "Supported values are..." is coming from the description and "Valid values are" is generated.

[Naarcha-AWS]

@kolchfa-aws: Yes, the enums are generated. The definition has been updated and is now consistent. 1495f2a

[kolchfa-aws]

LGTM

[opensearch-trigger-bot]

The backport to 2.18 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.18 2.18
# Navigate to the new working tree
pushd ../.worktrees/backport-2.18
# Create a new branch
git switch --create backport/backport-9060-to-2.18
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 0713861ee2c33b642d4966c591e72a0576781095
# Push it to GitHub
git push --set-upstream origin backport/backport-9060-to-2.18
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.18

Then, create a pull request where the base branch is 2.18 and the compare/head branch is backport/backport-9060-to-2.18.