Add spec and docs for new logs streams endpoints by lukewhiting · Pull Request #5258 · elastic/elasticsearch-specification

lukewhiting · 2025-09-04T12:46:03Z

This adds the new logs streams endpoints to the spec.

This will need backporting to 9.1 as that's when these endpoints were added.

Elasticsearch PR: elastic/elasticsearch#129474

Copilot

Pull Request Overview

This PR adds the new logs streams endpoints to the Elasticsearch specification, including API definitions for enabling, disabling, and checking the status of logs streams functionality.

Adds TypeScript interface definitions for three new logs streams endpoints
Includes comprehensive example files for requests and responses with various status codes
Updates the tsconfig.json to include the new streams module path mapping

Reviewed Changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
specification/tsconfig.json	Adds path mapping for the new @streams/* module
specification/streams/status/StreamsStatusRequest.ts	Defines the GET _streams/status endpoint interface
specification/streams/status/StreamsStatusResponse.ts	Defines response structure for streams status endpoint
specification/streams/logs_enable/StreamsLogsEnableRequest.ts	Defines the POST _streams/logs/_enable endpoint interface
specification/streams/logs_enable/StreamsLogsEnableResponse.ts	Defines response structure for logs enable endpoint
specification/streams/logs_disable/StreamsLogsDisableRequest.ts	Defines the POST _streams/logs/_disable endpoint interface
specification/streams/logs_disable/StreamsLogsDisableResponse.ts	Defines response structure for logs disable endpoint
Various example files	Provides request/response examples for all endpoints including error cases
docs/add-new-api.md	Minor grammar improvement in documentation

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

specification/streams/status/StreamsStatusRequest.ts

specification/streams/status/examples/200_response/GetStreamsStatusResponseExample1.yaml

…tatusResponseExample1.yaml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

specification/_doc_ids/table.csv

Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>

github-actions · 2025-09-05T13:03:06Z

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

API	Status	Request	Response
`streams.logs_disable`	🟠 → ⚪	Missing type → Missing test	Missing type → Missing test
`streams.logs_enable`	🟠 → ⚪	Missing type → Missing test	Missing type → Missing test
`streams.status`	🟠 → ⚪	Missing type → Missing test	Missing type → Missing test

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

pquentin

Thanks! This looks good. Sorry that reviewing took this long.

By the way, since elastic/elasticsearch#129474 has been backported to 8.19 too, I've added the 8.19 backport label. Is that fine?

specification/_doc_ids/table.csv

specification/streams/logs_disable/StreamsLogsDisableRequest.ts

Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>

lukewhiting · 2025-09-15T15:52:52Z

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

API Status Request Response
streams.logs_disable 🟠 → ⚪ Missing type → Missing test Missing type → Missing test
streams.logs_enable 🟠 → ⚪ Missing type → Missing test Missing type → Missing test
streams.status 🟠 → ⚪ Missing type → Missing test Missing type → Missing test
You can validate these APIs yourself by using the make validate target.

@pquentin Do I need to do anything about this? Are there any docs on writing these tests?

lukewhiting · 2025-09-15T15:53:40Z

Thanks! This looks good. Sorry that reviewing took this long.

By the way, since elastic/elasticsearch#129474 has been backported to 8.19 too, I've added the 8.19 backport label. Is that fine?

No that's fine :-) I have been off all last week so no rush.

I totally forget it got backported to 8.19... Thanks for adding that!

pquentin

Thanks! LGTM.

@pquentin Do I need to do anything about this? Are there any docs on writing these tests?

These are actaully the Elasticsearch YAML tests: we run them, record the requests and responses, and see if they match the specification. We need to add them module by module. I've just opened elastic/elasticsearch#134869 for this purpose. But it isn't blocking, so I'm merging.

github-actions · 2025-09-17T07:03:50Z

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-5258-to-8.19
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 995d6861198f6e1b3633ad63348a55ff572734d2
# Push it to GitHub
git push --set-upstream origin backport-5258-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-5258-to-8.19.

@codegen

* 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> (cherry picked from commit 995d686)

@codegen

* 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> (cherry picked from commit 995d686) # Conflicts: # specification/_doc_ids/table.csv

pquentin · 2025-09-17T07:18:17Z

💚 All backports created successfully

Status	Branch	Result
✅	8.19

Questions ?

Please refer to the Backport tool documentation

@codegen

* 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 * Correct feature flag * Add doc-ids * Fix doc-ids * Update specification/_doc_ids/table.csv * Update specification/_doc_ids/table.csv * Add default timeouts --------- (cherry picked from commit 995d686) Co-authored-by: Luke Whiting <luke.whiting@elastic.co> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>

@codegen

* 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> (cherry picked from commit 995d686) # Conflicts: # specification/_doc_ids/table.csv * Edit logs streams endpoints * Regenerate output --------- Co-authored-by: Luke Whiting <luke.whiting@elastic.co> Co-authored-by: lcawl <lcawley@elastic.co>

@codegen

* 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>

@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 spec and docs for new logs streams endpoints

266f534

lukewhiting requested review from Copilot and pquentin September 4, 2025 12:46

lukewhiting added documentation backport 9.1 labels Sep 4, 2025

github-actions bot added the specification label Sep 4, 2025

Copilot AI reviewed Sep 4, 2025

View reviewed changes

specification/streams/status/StreamsStatusRequest.ts Show resolved Hide resolved

specification/streams/status/examples/200_response/GetStreamsStatusResponseExample1.yaml Outdated Show resolved Hide resolved

lukewhiting and others added 6 commits September 4, 2025 13:48

Add @codegen name to Acked responses

e72eaab

Linting fix

cfc80e2

Update specification/streams/status/examples/200_response/GetStreamsS…

9b2fab6

…tatusResponseExample1.yaml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Correct feature flag

bf05570

Add doc-ids

9e8a27b

Fix doc-ids

97a6514

pquentin reviewed Sep 5, 2025

View reviewed changes

specification/_doc_ids/table.csv Outdated Show resolved Hide resolved

Update specification/_doc_ids/table.csv

2c2f8a6

Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>

pquentin added the backport 8.19 label Sep 11, 2025

pquentin reviewed Sep 11, 2025

View reviewed changes

specification/_doc_ids/table.csv Outdated Show resolved Hide resolved

specification/streams/logs_disable/StreamsLogsDisableRequest.ts Show resolved Hide resolved

pquentin and others added 3 commits September 12, 2025 16:35

Merge remote-tracking branch 'origin/main' into streams-logs-endpoints

2f5d1f7

Update specification/_doc_ids/table.csv

bc151f9

Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>

Add default timeouts

c84235a

lukewhiting requested a review from pquentin September 15, 2025 15:53

pquentin mentioned this pull request Sep 17, 2025

Add streams YAML tests to rest-resources-zip elastic/elasticsearch#134869

Merged

pquentin approved these changes Sep 17, 2025

View reviewed changes

pquentin merged commit 995d686 into main Sep 17, 2025
8 checks passed

pquentin deleted the streams-logs-endpoints branch September 17, 2025 07:02

github-actions bot mentioned this pull request Sep 17, 2025

[Backport 9.1] Add spec and docs for new logs streams endpoints #5300

Merged

pquentin mentioned this pull request Sep 17, 2025

[8.19] Add spec and docs for new logs streams endpoints (#5258) #5301

Merged

lcawl mentioned this pull request Sep 17, 2025

Edit the log streams endpoint docs #5305

Merged

pquentin mentioned this pull request Oct 15, 2025

streams: fix stability/documentation elastic/elasticsearch#136642

Merged

lcawl mentioned this pull request Feb 26, 2026

Add overlay for Streams APIs #6068

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add spec and docs for new logs streams endpoints#5258

Add spec and docs for new logs streams endpoints#5258
pquentin merged 11 commits intomainfrom
streams-logs-endpoints

lukewhiting commented Sep 4, 2025 •

edited by pquentin

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Sep 5, 2025 •

edited

Loading

Uh oh!

pquentin left a comment

Uh oh!

Uh oh!

Uh oh!

lukewhiting commented Sep 15, 2025

Uh oh!

lukewhiting commented Sep 15, 2025

Uh oh!

pquentin left a comment

Uh oh!

Uh oh!

github-actions bot commented Sep 17, 2025

Uh oh!

pquentin commented Sep 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

lukewhiting commented Sep 4, 2025 • edited by pquentin Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pquentin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lukewhiting commented Sep 15, 2025

Uh oh!

lukewhiting commented Sep 15, 2025

Uh oh!

pquentin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Sep 17, 2025

Uh oh!

pquentin commented Sep 17, 2025

💚 All backports created successfully

Questions ?

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lukewhiting commented Sep 4, 2025 •

edited by pquentin

Loading

github-actions bot commented Sep 5, 2025 •

edited

Loading