Add common cat API parameters for unit rendering

[DaveCTurner]

Describes the ?bytes= and ?time= parameters which are accepted by
all the GET _cat/... APIs.

[DaveCTurner]

Not sure what to do with this one - it doesn't seem to be defined anywhere yet.

[pquentin]

I would add a new UnitSize enum in _types/common.ts next to Bytes.

[DaveCTurner]

It's telling me to run prettier but I do not have this tool.

Also this seems problematic:

Error: ../output/typescript/types.ts(8097,18): error TS2430: Interface 'CatMlTrainedModelsRequest' incorrectly extends interface 'CatCatRequestBase'.
  Types of property 'size' are incompatible.
    Type 'number' is not assignable to type '"" | "p" | "g" | "m" | "k" | "t"'.
Error: ../output/typescript/types.ts(9032,18): error TS2430: Interface 'CatTransformsRequest' incorrectly extends interface 'CatCatRequestBase'.
  Types of property 'size' are incompatible.
    Type 'number' is not assignable to type '"" | "p" | "g" | "m" | "k" | "t"'.
make: *** [Makefile:12: generate] Error 2

The ?size parameter is indeed overloaded for these APIs. Not sure what to do about that.

[pquentin]

It's telling me to run prettier but I do not have this tool.

make contrib usually takes care of it, but it currently fails due to the size issue, so I've used make spec-format-fix instead.

The ?size parameter is indeed overloaded for these APIs. Not sure what to do about that.

The last time we had such an issue, we decided to remove the affected parameter from the common cat parameters and explicitly place it in each API where it made sense. Doing this will be easier than fighting the TypeScript compiler which correctly errors out here.

[DaveCTurner]

Ok I looked more deeply and I think the ?size parameter is a complete no-op, so I've just dropped it here.

Edit: also opened elastic/elasticsearch#134871 to drop the SizeValue concept entirely.

[github-actions]

Following you can find the validation changes against the target branch for the APIs.

No changes detected.

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

[pquentin]

Thank you! LGTM.

[DaveCTurner]

Thanks Quentin. Do I need to wait for elastic/elasticsearch#134870 to land and then adjust things here, or is it ok to merge this first?

[pquentin]

It's OK to merge this first. We have automation to sync the rest-api-spec from Elasticsearch to the specification that will remove the errors. (I did check that the changes were the same in both places.)

[github-actions]

The backport to 8.19 failed:

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

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-8.19 8.19
# Navigate to the new working tree
cd .worktrees/backport-8.19
# Create a new branch
git switch --create backport-5298-to-8.19
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 e22c10134264a91aca0f736153460a3e988c27b5
# Push it to GitHub
git push --set-upstream origin backport-5298-to-8.19
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.19

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

[github-actions]

The backport to 9.1 failed:

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

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-9.1 9.1
# Navigate to the new working tree
cd .worktrees/backport-9.1
# Create a new branch
git switch --create backport-5298-to-9.1
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 e22c10134264a91aca0f736153460a3e988c27b5
# Push it to GitHub
git push --set-upstream origin backport-5298-to-9.1
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.1

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