Add common cat API parameters for unit rendering by DaveCTurner · Pull Request #5298 · elastic/elasticsearch-specification

DaveCTurner · 2025-09-16T15:04:26Z

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

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

DaveCTurner · 2025-09-16T15:04:48Z

specification/_spec_utils/behaviors.ts

+   * If given, size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit.
+   * Values that are not an exact multiple of the chosen unit are rounded down.
+   */
+  size?: '' | 'k' | 'm' | 'g' | 't' | 'p'


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

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

specification/shutdown/delete_node/ShutdownDeleteNodeRequest.ts

DaveCTurner · 2025-09-16T15:23:11Z

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 · 2025-09-17T06:38:05Z

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.

Relates elastic/elasticsearch-specification#5298

DaveCTurner · 2025-09-17T07:14:07Z

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 · 2025-09-17T07:33:59Z

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 · 2025-09-17T07:47:49Z

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 · 2025-09-17T07:54:51Z

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 · 2025-09-17T08:02:37Z

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 · 2025-09-17T08:02:39Z

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.

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

Describes the `?bytes=` and `?time=` parameters which are accepted by all the `GET _cat/...` APIs. Backport of #5298 to `9.1`

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

Relates elastic/elasticsearch-specification#5298 Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>

Relates elastic/elasticsearch-specification#5298 Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> (cherry picked from commit d0ea79a) # Conflicts: # rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json

Relates elastic/elasticsearch-specification#5298 Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>

Relates elastic/elasticsearch-specification#5298 Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> (cherry picked from commit d0ea79a) # Conflicts: # rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json Co-authored-by: David Turner <david.turner@elastic.co>

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

@codegen

* Add initial rest-api-spec converter * Wrap JSON data with endpoint name * Add headers * Extract visibility * Add debug logging for types * Improve type handling * Extract builting mappings * Skip empty headers * Add more mappings * Add required field to bodies * Support CommonCatQueryParameters * Fix availability/stability * Improve urls generation * Serialize description only if required? * Support more complex types * Add spec and docs for new logs streams endpoints (#5258) * Add spec and docs for new logs streams endpoints * Add @codegen name to Acked responses * Linting fix * Update specification/streams/status/examples/200_response/GetStreamsStatusResponseExample1.yaml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Correct feature flag * Add doc-ids * Fix doc-ids * Update specification/_doc_ids/table.csv Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Update specification/_doc_ids/table.csv Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Add default timeouts --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Update specification output * Add common cat API parameters for unit rendering (#5298) Describes the `?bytes=` and `?time=` parameters which are accepted by all the `GET _cat/...` APIs. * Edit the log streams endpoint docs (#5305) * Add speficaiton for a new rescore type (#5308) Based on PR elastic/elasticsearch#74274 * Update specification output * Update rest-api-spec (#5294) Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> * Update rest-api-spec (#5311) Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> * Commit Cargo.lock changes * Show unexpected union * Remove '| string' in query parameters * Always specify body.required * Fix type for uint * Return string for string | string[] * Skip empty descriptions * Remove redundant code comments * Specify default_value for expand_wildcards * Stop hardcoding expand_wildcards * Improve union handling * Hardcode "serialize": "bulk" endpoints * Handle deprecated URLs parts * Improve diff script * Tweak converter * Handle parameter visibility * Handle required parameters * Fix required parameters * Fix experimental indices sample APIs * Allow string[] for routing parameters * Fix type of if_version in ingest.put_pipeline * Fix type of search_type in rank_eval * Fix type of CategoryId * Mark find_structure column_names as string | string[] * Allow empty URLs * Handle number|string special cases * Handle Fleet IndexName | IndexCase case * Fail on unknown cases * Improve diff * Remvope file committed by mistake * Add optional body to three ML APIs * Fix ccs_minimize_roundtrips default value * Fix description for parameter that does not accept comma-separated values * Stop trying to document private API * Remove parameter in find_structure API * Fix find_stucture format enum * Remove cruft * Remove more cruft * Update Rust edition to 2024 and refactor conditional statements * Clarify main.rs Print at the correct place and use crate prefixes * Remove diplay() call * Add TODOs * Remove wrong doc_id from knn_search * Add body to project.tags * Run make spec-format-fix * wip * Switch to HttpMethod enum * Use http::Method and implement TryFrom * Use enums for stability and visibility * Switch parameter types to enum * Simplify BUILTING_MAPPINGS code * Add top-level Cargo.lock change * Add WASM integration for rest-api-spec generation * Fix leftovers from previous commit * Restrict WASM tracing to INFO * Add _common.json generation * Rename is_literal to get_literal * Fix indices.get_settings expand_wildcards default --------- Co-authored-by: Luke Whiting <luke.whiting@elastic.co> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: David Turner <david.turner@elastic.co> Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Mayya Sharipova <mayya.sharipova@elastic.co> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> Co-authored-by: Laurent Saint-Félix <laurent.saintfelix@elastic.co>

@codegen

* Add initial rest-api-spec converter * Wrap JSON data with endpoint name * Add headers * Extract visibility * Add debug logging for types * Improve type handling * Extract builting mappings * Skip empty headers * Add more mappings * Add required field to bodies * Support CommonCatQueryParameters * Fix availability/stability * Improve urls generation * Serialize description only if required? * Support more complex types * Add spec and docs for new logs streams endpoints (#5258) * Add spec and docs for new logs streams endpoints * Add @codegen name to Acked responses * Linting fix * Update specification/streams/status/examples/200_response/GetStreamsStatusResponseExample1.yaml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Correct feature flag * Add doc-ids * Fix doc-ids * Update specification/_doc_ids/table.csv Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Update specification/_doc_ids/table.csv Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Add default timeouts --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Update specification output * Add common cat API parameters for unit rendering (#5298) Describes the `?bytes=` and `?time=` parameters which are accepted by all the `GET _cat/...` APIs. * Edit the log streams endpoint docs (#5305) * Add speficaiton for a new rescore type (#5308) Based on PR elastic/elasticsearch#74274 * Update specification output * Update rest-api-spec (#5294) Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> * Update rest-api-spec (#5311) Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> * Commit Cargo.lock changes * Show unexpected union * Remove '| string' in query parameters * Always specify body.required * Fix type for uint * Return string for string | string[] * Skip empty descriptions * Remove redundant code comments * Specify default_value for expand_wildcards * Stop hardcoding expand_wildcards * Improve union handling * Hardcode "serialize": "bulk" endpoints * Handle deprecated URLs parts * Improve diff script * Tweak converter * Handle parameter visibility * Handle required parameters * Fix required parameters * Fix experimental indices sample APIs * Allow string[] for routing parameters * Fix type of if_version in ingest.put_pipeline * Fix type of search_type in rank_eval * Fix type of CategoryId * Mark find_structure column_names as string | string[] * Allow empty URLs * Handle number|string special cases * Handle Fleet IndexName | IndexCase case * Fail on unknown cases * Improve diff * Remvope file committed by mistake * Add optional body to three ML APIs * Fix ccs_minimize_roundtrips default value * Fix description for parameter that does not accept comma-separated values * Stop trying to document private API * Remove parameter in find_structure API * Fix find_stucture format enum * Remove cruft * Remove more cruft * Update Rust edition to 2024 and refactor conditional statements * Clarify main.rs Print at the correct place and use crate prefixes * Remove diplay() call * Add TODOs * Remove wrong doc_id from knn_search * Add body to project.tags * Run make spec-format-fix * wip * Switch to HttpMethod enum * Use http::Method and implement TryFrom * Use enums for stability and visibility * Switch parameter types to enum * Simplify BUILTING_MAPPINGS code * Add top-level Cargo.lock change * Add WASM integration for rest-api-spec generation * Fix leftovers from previous commit * Restrict WASM tracing to INFO * Add _common.json generation * Rename is_literal to get_literal * Fix indices.get_settings expand_wildcards default --------- Co-authored-by: Luke Whiting <luke.whiting@elastic.co> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: David Turner <david.turner@elastic.co> Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Mayya Sharipova <mayya.sharipova@elastic.co> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> Co-authored-by: Laurent Saint-Félix <laurent.saintfelix@elastic.co> (cherry picked from commit 7b7e18a) # Conflicts: # compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm # specification/streams/logs_disable/StreamsLogsDisableRequest.ts # specification/streams/logs_enable/StreamsLogsEnableRequest.ts

@codegen

* Add initial rest-api-spec converter * Wrap JSON data with endpoint name * Add headers * Extract visibility * Add debug logging for types * Improve type handling * Extract builting mappings * Skip empty headers * Add more mappings * Add required field to bodies * Support CommonCatQueryParameters * Fix availability/stability * Improve urls generation * Serialize description only if required? * Support more complex types * Add spec and docs for new logs streams endpoints (#5258) * Add spec and docs for new logs streams endpoints * Add @codegen name to Acked responses * Linting fix * Update specification/streams/status/examples/200_response/GetStreamsStatusResponseExample1.yaml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Correct feature flag * Add doc-ids * Fix doc-ids * Update specification/_doc_ids/table.csv Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Update specification/_doc_ids/table.csv Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Add default timeouts --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Update specification output * Add common cat API parameters for unit rendering (#5298) Describes the `?bytes=` and `?time=` parameters which are accepted by all the `GET _cat/...` APIs. * Edit the log streams endpoint docs (#5305) * Add speficaiton for a new rescore type (#5308) Based on PR elastic/elasticsearch#74274 * Update specification output * Update rest-api-spec (#5294) Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> * Update rest-api-spec (#5311) Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> * Commit Cargo.lock changes * Show unexpected union * Remove '| string' in query parameters * Always specify body.required * Fix type for uint * Return string for string | string[] * Skip empty descriptions * Remove redundant code comments * Specify default_value for expand_wildcards * Stop hardcoding expand_wildcards * Improve union handling * Hardcode "serialize": "bulk" endpoints * Handle deprecated URLs parts * Improve diff script * Tweak converter * Handle parameter visibility * Handle required parameters * Fix required parameters * Fix experimental indices sample APIs * Allow string[] for routing parameters * Fix type of if_version in ingest.put_pipeline * Fix type of search_type in rank_eval * Fix type of CategoryId * Mark find_structure column_names as string | string[] * Allow empty URLs * Handle number|string special cases * Handle Fleet IndexName | IndexCase case * Fail on unknown cases * Improve diff * Remvope file committed by mistake * Add optional body to three ML APIs * Fix ccs_minimize_roundtrips default value * Fix description for parameter that does not accept comma-separated values * Stop trying to document private API * Remove parameter in find_structure API * Fix find_stucture format enum * Remove cruft * Remove more cruft * Update Rust edition to 2024 and refactor conditional statements * Clarify main.rs Print at the correct place and use crate prefixes * Remove diplay() call * Add TODOs * Remove wrong doc_id from knn_search * Add body to project.tags * Run make spec-format-fix * wip * Switch to HttpMethod enum * Use http::Method and implement TryFrom * Use enums for stability and visibility * Switch parameter types to enum * Simplify BUILTING_MAPPINGS code * Add top-level Cargo.lock change * Add WASM integration for rest-api-spec generation * Fix leftovers from previous commit * Restrict WASM tracing to INFO * Add _common.json generation * Rename is_literal to get_literal * Fix indices.get_settings expand_wildcards default --------- Co-authored-by: Luke Whiting <luke.whiting@elastic.co> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: David Turner <david.turner@elastic.co> Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Mayya Sharipova <mayya.sharipova@elastic.co> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> Co-authored-by: Laurent Saint-Félix <laurent.saintfelix@elastic.co> (cherry picked from commit 7b7e18a) # Conflicts: # compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm # specification/inference/put_groq/PutGroqRequest.ts # specification/inference/put_nvidia/PutNvidiaRequest.ts # specification/streams/logs_disable/StreamsLogsDisableRequest.ts # specification/streams/logs_enable/StreamsLogsEnableRequest.ts

@codegen

* Add initial rest-api-spec converter * Wrap JSON data with endpoint name * Add headers * Extract visibility * Add debug logging for types * Improve type handling * Extract builting mappings * Skip empty headers * Add more mappings * Add required field to bodies * Support CommonCatQueryParameters * Fix availability/stability * Improve urls generation * Serialize description only if required? * Support more complex types * Add spec and docs for new logs streams endpoints (#5258) * Add spec and docs for new logs streams endpoints * Add @codegen name to Acked responses * Linting fix * Update specification/streams/status/examples/200_response/GetStreamsStatusResponseExample1.yaml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Correct feature flag * Add doc-ids * Fix doc-ids * Update specification/_doc_ids/table.csv Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Update specification/_doc_ids/table.csv Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Add default timeouts --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Update specification output * Add common cat API parameters for unit rendering (#5298) Describes the `?bytes=` and `?time=` parameters which are accepted by all the `GET _cat/...` APIs. * Edit the log streams endpoint docs (#5305) * Add speficaiton for a new rescore type (#5308) Based on PR elastic/elasticsearch#74274 * Update specification output * Update rest-api-spec (#5294) Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> * Update rest-api-spec (#5311) Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> * Commit Cargo.lock changes * Show unexpected union * Remove '| string' in query parameters * Always specify body.required * Fix type for uint * Return string for string | string[] * Skip empty descriptions * Remove redundant code comments * Specify default_value for expand_wildcards * Stop hardcoding expand_wildcards * Improve union handling * Hardcode "serialize": "bulk" endpoints * Handle deprecated URLs parts * Improve diff script * Tweak converter * Handle parameter visibility * Handle required parameters * Fix required parameters * Fix experimental indices sample APIs * Allow string[] for routing parameters * Fix type of if_version in ingest.put_pipeline * Fix type of search_type in rank_eval * Fix type of CategoryId * Mark find_structure column_names as string | string[] * Allow empty URLs * Handle number|string special cases * Handle Fleet IndexName | IndexCase case * Fail on unknown cases * Improve diff * Remvope file committed by mistake * Add optional body to three ML APIs * Fix ccs_minimize_roundtrips default value * Fix description for parameter that does not accept comma-separated values * Stop trying to document private API * Remove parameter in find_structure API * Fix find_stucture format enum * Remove cruft * Remove more cruft * Update Rust edition to 2024 and refactor conditional statements * Clarify main.rs Print at the correct place and use crate prefixes * Remove diplay() call * Add TODOs * Remove wrong doc_id from knn_search * Add body to project.tags * Run make spec-format-fix * wip * Switch to HttpMethod enum * Use http::Method and implement TryFrom * Use enums for stability and visibility * Switch parameter types to enum * Simplify BUILTING_MAPPINGS code * Add top-level Cargo.lock change * Add WASM integration for rest-api-spec generation * Fix leftovers from previous commit * Restrict WASM tracing to INFO * Add _common.json generation * Rename is_literal to get_literal * Fix indices.get_settings expand_wildcards default --------- Co-authored-by: Luke Whiting <luke.whiting@elastic.co> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: David Turner <david.turner@elastic.co> Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Mayya Sharipova <mayya.sharipova@elastic.co> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> Co-authored-by: Laurent Saint-Félix <laurent.saintfelix@elastic.co> (cherry picked from commit 7b7e18a) # Conflicts: # compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm # specification/inference/put_groq/PutGroqRequest.ts # specification/inference/put_nvidia/PutNvidiaRequest.ts # specification/streams/logs_disable/StreamsLogsDisableRequest.ts # specification/streams/logs_enable/StreamsLogsEnableRequest.ts

@codegen

* Add initial rest-api-spec converter * Wrap JSON data with endpoint name * Add headers * Extract visibility * Add debug logging for types * Improve type handling * Extract builting mappings * Skip empty headers * Add more mappings * Add required field to bodies * Support CommonCatQueryParameters * Fix availability/stability * Improve urls generation * Serialize description only if required? * Support more complex types * Add spec and docs for new logs streams endpoints (#5258) * Add spec and docs for new logs streams endpoints * Add @codegen name to Acked responses * Linting fix * Update specification/streams/status/examples/200_response/GetStreamsStatusResponseExample1.yaml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Correct feature flag * Add doc-ids * Fix doc-ids * Update specification/_doc_ids/table.csv Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Update specification/_doc_ids/table.csv Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Add default timeouts --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Update specification output * Add common cat API parameters for unit rendering (#5298) Describes the `?bytes=` and `?time=` parameters which are accepted by all the `GET _cat/...` APIs. * Edit the log streams endpoint docs (#5305) * Add speficaiton for a new rescore type (#5308) Based on PR elastic/elasticsearch#74274 * Update specification output * Update rest-api-spec (#5294) Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> * Update rest-api-spec (#5311) Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> * Commit Cargo.lock changes * Show unexpected union * Remove '| string' in query parameters * Always specify body.required * Fix type for uint * Return string for string | string[] * Skip empty descriptions * Remove redundant code comments * Specify default_value for expand_wildcards * Stop hardcoding expand_wildcards * Improve union handling * Hardcode "serialize": "bulk" endpoints * Handle deprecated URLs parts * Improve diff script * Tweak converter * Handle parameter visibility * Handle required parameters * Fix required parameters * Fix experimental indices sample APIs * Allow string[] for routing parameters * Fix type of if_version in ingest.put_pipeline * Fix type of search_type in rank_eval * Fix type of CategoryId * Mark find_structure column_names as string | string[] * Allow empty URLs * Handle number|string special cases * Handle Fleet IndexName | IndexCase case * Fail on unknown cases * Improve diff * Remvope file committed by mistake * Add optional body to three ML APIs * Fix ccs_minimize_roundtrips default value * Fix description for parameter that does not accept comma-separated values * Stop trying to document private API * Remove parameter in find_structure API * Fix find_stucture format enum * Remove cruft * Remove more cruft * Update Rust edition to 2024 and refactor conditional statements * Clarify main.rs Print at the correct place and use crate prefixes * Remove diplay() call * Add TODOs * Remove wrong doc_id from knn_search * Add body to project.tags * Run make spec-format-fix * wip * Switch to HttpMethod enum * Use http::Method and implement TryFrom * Use enums for stability and visibility * Switch parameter types to enum * Simplify BUILTING_MAPPINGS code * Add top-level Cargo.lock change * Add WASM integration for rest-api-spec generation * Fix leftovers from previous commit * Restrict WASM tracing to INFO * Add _common.json generation * Rename is_literal to get_literal * Fix indices.get_settings expand_wildcards default --------- Co-authored-by: Luke Whiting <luke.whiting@elastic.co> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: David Turner <david.turner@elastic.co> Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Mayya Sharipova <mayya.sharipova@elastic.co> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> Co-authored-by: Laurent Saint-Félix <laurent.saintfelix@elastic.co> (cherry picked from commit 7b7e18a) # Conflicts: # compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm # specification/inference/put_groq/PutGroqRequest.ts # specification/inference/put_nvidia/PutNvidiaRequest.ts # specification/streams/logs_disable/StreamsLogsDisableRequest.ts # specification/streams/logs_enable/StreamsLogsEnableRequest.ts

@codegen

* Add initial rest-api-spec converter * Wrap JSON data with endpoint name * Add headers * Extract visibility * Add debug logging for types * Improve type handling * Extract builting mappings * Skip empty headers * Add more mappings * Add required field to bodies * Support CommonCatQueryParameters * Fix availability/stability * Improve urls generation * Serialize description only if required? * Support more complex types * Add spec and docs for new logs streams endpoints (#5258) * Add spec and docs for new logs streams endpoints * Add @codegen name to Acked responses * Linting fix * Update specification/streams/status/examples/200_response/GetStreamsStatusResponseExample1.yaml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Correct feature flag * Add doc-ids * Fix doc-ids * Update specification/_doc_ids/table.csv Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Update specification/_doc_ids/table.csv Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Add default timeouts --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Update specification output * Add common cat API parameters for unit rendering (#5298) Describes the `?bytes=` and `?time=` parameters which are accepted by all the `GET _cat/...` APIs. * Edit the log streams endpoint docs (#5305) * Add speficaiton for a new rescore type (#5308) Based on PR elastic/elasticsearch#74274 * Update specification output * Update rest-api-spec (#5294) Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> * Update rest-api-spec (#5311) Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> * Commit Cargo.lock changes * Show unexpected union * Remove '| string' in query parameters * Always specify body.required * Fix type for uint * Return string for string | string[] * Skip empty descriptions * Remove redundant code comments * Specify default_value for expand_wildcards * Stop hardcoding expand_wildcards * Improve union handling * Hardcode "serialize": "bulk" endpoints * Handle deprecated URLs parts * Improve diff script * Tweak converter * Handle parameter visibility * Handle required parameters * Fix required parameters * Fix experimental indices sample APIs * Allow string[] for routing parameters * Fix type of if_version in ingest.put_pipeline * Fix type of search_type in rank_eval * Fix type of CategoryId * Mark find_structure column_names as string | string[] * Allow empty URLs * Handle number|string special cases * Handle Fleet IndexName | IndexCase case * Fail on unknown cases * Improve diff * Remvope file committed by mistake * Add optional body to three ML APIs * Fix ccs_minimize_roundtrips default value * Fix description for parameter that does not accept comma-separated values * Stop trying to document private API * Remove parameter in find_structure API * Fix find_stucture format enum * Remove cruft * Remove more cruft * Update Rust edition to 2024 and refactor conditional statements * Clarify main.rs Print at the correct place and use crate prefixes * Remove diplay() call * Add TODOs * Remove wrong doc_id from knn_search * Add body to project.tags * Run make spec-format-fix * wip * Switch to HttpMethod enum * Use http::Method and implement TryFrom * Use enums for stability and visibility * Switch parameter types to enum * Simplify BUILTING_MAPPINGS code * Add top-level Cargo.lock change * Add WASM integration for rest-api-spec generation * Fix leftovers from previous commit * Restrict WASM tracing to INFO * Add _common.json generation * Rename is_literal to get_literal * Fix indices.get_settings expand_wildcards default --------- Co-authored-by: Luke Whiting <luke.whiting@elastic.co> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: David Turner <david.turner@elastic.co> Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Mayya Sharipova <mayya.sharipova@elastic.co> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> Co-authored-by: Laurent Saint-Félix <laurent.saintfelix@elastic.co> (cherry picked from commit 7b7e18a) # Conflicts: # compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm # specification/streams/logs_disable/StreamsLogsDisableRequest.ts # specification/streams/logs_enable/StreamsLogsEnableRequest.ts

@codegen

* Add initial rest-api-spec converter * Wrap JSON data with endpoint name * Add headers * Extract visibility * Add debug logging for types * Improve type handling * Extract builting mappings * Skip empty headers * Add more mappings * Add required field to bodies * Support CommonCatQueryParameters * Fix availability/stability * Improve urls generation * Serialize description only if required? * Support more complex types * Add spec and docs for new logs streams endpoints (#5258) * Add spec and docs for new logs streams endpoints * Add @codegen name to Acked responses * Linting fix * Update specification/streams/status/examples/200_response/GetStreamsStatusResponseExample1.yaml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Correct feature flag * Add doc-ids * Fix doc-ids * Update specification/_doc_ids/table.csv Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Update specification/_doc_ids/table.csv Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Add default timeouts --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> * Update specification output * Add common cat API parameters for unit rendering (#5298) Describes the `?bytes=` and `?time=` parameters which are accepted by all the `GET _cat/...` APIs. * Edit the log streams endpoint docs (#5305) * Add speficaiton for a new rescore type (#5308) Based on PR elastic/elasticsearch#74274 * Update specification output * Update rest-api-spec (#5294) Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> * Update rest-api-spec (#5311) Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> * Commit Cargo.lock changes * Show unexpected union * Remove '| string' in query parameters * Always specify body.required * Fix type for uint * Return string for string | string[] * Skip empty descriptions * Remove redundant code comments * Specify default_value for expand_wildcards * Stop hardcoding expand_wildcards * Improve union handling * Hardcode "serialize": "bulk" endpoints * Handle deprecated URLs parts * Improve diff script * Tweak converter * Handle parameter visibility * Handle required parameters * Fix required parameters * Fix experimental indices sample APIs * Allow string[] for routing parameters * Fix type of if_version in ingest.put_pipeline * Fix type of search_type in rank_eval * Fix type of CategoryId * Mark find_structure column_names as string | string[] * Allow empty URLs * Handle number|string special cases * Handle Fleet IndexName | IndexCase case * Fail on unknown cases * Improve diff * Remvope file committed by mistake * Add optional body to three ML APIs * Fix ccs_minimize_roundtrips default value * Fix description for parameter that does not accept comma-separated values * Stop trying to document private API * Remove parameter in find_structure API * Fix find_stucture format enum * Remove cruft * Remove more cruft * Update Rust edition to 2024 and refactor conditional statements * Clarify main.rs Print at the correct place and use crate prefixes * Remove diplay() call * Add TODOs * Remove wrong doc_id from knn_search * Add body to project.tags * Run make spec-format-fix * wip * Switch to HttpMethod enum * Use http::Method and implement TryFrom * Use enums for stability and visibility * Switch parameter types to enum * Simplify BUILTING_MAPPINGS code * Add top-level Cargo.lock change * Add WASM integration for rest-api-spec generation * Fix leftovers from previous commit * Restrict WASM tracing to INFO * Add _common.json generation * Rename is_literal to get_literal * Fix indices.get_settings expand_wildcards default --------- Co-authored-by: Luke Whiting <luke.whiting@elastic.co> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: David Turner <david.turner@elastic.co> Co-authored-by: Lisa Cawley <lcawley@elastic.co> Co-authored-by: Mayya Sharipova <mayya.sharipova@elastic.co> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> Co-authored-by: Laurent Saint-Félix <laurent.saintfelix@elastic.co>

Add common cat API parameters for unit rendering

e357988

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

DaveCTurner requested a review from pquentin September 16, 2025 15:04

DaveCTurner requested a review from a team as a code owner September 16, 2025 15:04

DaveCTurner added specification skip-backport This pull request should not be backported labels Sep 16, 2025

DaveCTurner commented Sep 16, 2025

View reviewed changes

DaveCTurner added 3 commits September 16, 2025 16:09

Missing imports

250c1f7

Clean up imports

23eb76f

Moar imports

c0c9a7d

Run make spec-format-fix

b05beff

Drop unnecessary size param

cedb1ea

DaveCTurner added a commit to DaveCTurner/elasticsearch that referenced this pull request Sep 17, 2025

Add missing common cat params

23d29a0

Relates elastic/elasticsearch-specification#5298

DaveCTurner mentioned this pull request Sep 17, 2025

Add missing common cat params elastic/elasticsearch#134870

Merged

make contrib

2c0f5bc

DaveCTurner added 2 commits September 17, 2025 08:27

Merge branch 'main' into 2025/09/16/common-cat-unit-parameters

1dd611c

make contrib again

709884b

pquentin approved these changes Sep 17, 2025

View reviewed changes

pquentin added backport 8.19 backport 9.1 and removed skip-backport This pull request should not be backported labels Sep 17, 2025

DaveCTurner merged commit e22c101 into main Sep 17, 2025
12 of 13 checks passed

DaveCTurner deleted the 2025/09/16/common-cat-unit-parameters branch September 17, 2025 08:01

DaveCTurner added a commit that referenced this pull request Sep 17, 2025

Add common cat API parameters for unit rendering (#5298)

d298939

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

DaveCTurner mentioned this pull request Sep 17, 2025

[8.19] Add common cat API parameters for unit rendering #5302

Merged

DaveCTurner added a commit that referenced this pull request Sep 17, 2025

Add common cat API parameters for unit rendering

7a78677

Describes the `?bytes=` and `?time=` parameters which are accepted by all the `GET _cat/...` APIs. Backport of #5298 to `9.1`

DaveCTurner mentioned this pull request Sep 17, 2025

[9.1] Add common cat API parameters for unit rendering #5303

Merged

pquentin pushed a commit that referenced this pull request Sep 17, 2025

Add common cat API parameters for unit rendering (#5303)

e7864c2

Describes the `?bytes=` and `?time=` parameters which are accepted by all the `GET _cat/...` APIs. Backport of #5298 to `9.1`

pquentin pushed a commit that referenced this pull request Sep 17, 2025

Add common cat API parameters for unit rendering (#5298) (#5302)

d5c9dc8

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

pquentin added a commit to elastic/elasticsearch that referenced this pull request Sep 18, 2025

Add missing common cat params (#134870)

d0ea79a

Relates elastic/elasticsearch-specification#5298 Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>

gmjehovich pushed a commit to gmjehovich/elasticsearch that referenced this pull request Sep 18, 2025

Add missing common cat params (elastic#134870)

bbfd674

Relates elastic/elasticsearch-specification#5298 Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>

pquentin pushed a commit that referenced this pull request Oct 7, 2025

Add common cat API parameters for unit rendering (#5298)

ff98251

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add common cat API parameters for unit rendering#5298

Add common cat API parameters for unit rendering#5298
DaveCTurner merged 9 commits intomainfrom
2025/09/16/common-cat-unit-parameters

DaveCTurner commented Sep 16, 2025 •

edited

Loading

Uh oh!

DaveCTurner Sep 16, 2025

Uh oh!

pquentin Sep 17, 2025

Uh oh!

Uh oh!

DaveCTurner commented Sep 16, 2025

Uh oh!

pquentin commented Sep 17, 2025

Uh oh!

DaveCTurner commented Sep 17, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Sep 17, 2025

Uh oh!

pquentin left a comment

Uh oh!

DaveCTurner commented Sep 17, 2025

Uh oh!

pquentin commented Sep 17, 2025

Uh oh!

Uh oh!

github-actions bot commented Sep 17, 2025

Uh oh!

github-actions bot commented Sep 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

DaveCTurner commented Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DaveCTurner Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

pquentin Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

DaveCTurner commented Sep 16, 2025

Uh oh!

pquentin commented Sep 17, 2025

Uh oh!

DaveCTurner commented Sep 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Sep 17, 2025

Uh oh!

pquentin left a comment

Choose a reason for hiding this comment

Uh oh!

DaveCTurner commented Sep 17, 2025

Uh oh!

pquentin commented Sep 17, 2025

Uh oh!

Uh oh!

github-actions bot commented Sep 17, 2025

Uh oh!

github-actions bot commented Sep 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

DaveCTurner commented Sep 16, 2025 •

edited

Loading

DaveCTurner commented Sep 17, 2025 •

edited

Loading