Skip to content

Edit the log streams endpoint docs#5305

Merged
lcawl merged 2 commits intomainfrom
log-stream-docs
Sep 17, 2025
Merged

Edit the log streams endpoint docs#5305
lcawl merged 2 commits intomainfrom
log-stream-docs

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented Sep 17, 2025

Relates to #5258

This PR adds some simple edits to:

  • add a missing description for the enabled property
  • add use of "turn off" and "turn on" alongside "disable" and "enable" to align with word choice guidelines

@github-actions
Copy link
Copy Markdown
Contributor

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.

@lcawl lcawl merged commit 7dec8b0 into main Sep 17, 2025
14 checks passed
@lcawl lcawl deleted the log-stream-docs branch September 17, 2025 16:43
@github-actions
Copy link
Copy Markdown
Contributor

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

github-actions bot pushed a commit that referenced this pull request Sep 17, 2025
lcawl added a commit that referenced this pull request Sep 17, 2025
(cherry picked from commit 7dec8b0)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
pquentin pushed a commit that referenced this pull request Oct 7, 2025
pquentin added a commit that referenced this pull request Mar 9, 2026
* 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>
pquentin added a commit that referenced this pull request Mar 11, 2026
* 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
pquentin added a commit that referenced this pull request Mar 11, 2026
* 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
pquentin added a commit that referenced this pull request Mar 11, 2026
* 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
pquentin added a commit that referenced this pull request Mar 11, 2026
* 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
pquentin added a commit that referenced this pull request Mar 11, 2026
* 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
gmjehovich pushed a commit that referenced this pull request Apr 13, 2026
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants