Fix optional bodies #5271

pquentin · 2025-09-09T13:09:15Z

Many bodies were correctly set as optional in the rest-api-spec, but incorrectly set as required in the Elasticsearch specification. There are three errors in rest-api-spec too. When I fix them, I can commit the compiler change that allowed me to see this.

github-actions · 2025-09-09T13:11:29Z

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

API	Status	Request	Response
`indices.simulate_index_template`	🔴	8/10 → 10/10	6/10

You can validate this API yourself by using the make validate target.

pquentin

For each change, I have linked the corresponding server code justifying the change and sometimes additional evidence.

pquentin · 2025-09-09T13:09:38Z

specification/ccr/resume_follow/ResumeFollowIndexRequest.ts

 master_timeout?: Duration
 }
- body: {
+ body?: {


https://github.com/elastic/elasticsearch/blob/e5c91ca8ecc572dfb9c29b64f3574e650e1d2a06/x-pack/plugin/ccr/src/main/java/org/elasticsearch/xpack/ccr/rest/RestResumeFollowAction.java#L41-L52

pquentin · 2025-09-09T13:10:03Z

specification/async_search/submit/AsyncSearchSubmitRequest.ts

 sort?: string | string[]
 }
- body: {
+ body?: {


https://github.com/elastic/elasticsearch/blob/e5c91ca8ecc572dfb9c29b64f3574e650e1d2a06/x-pack/plugin/async-search/src/main/java/org/elasticsearch/xpack/search/RestSubmitAsyncSearchAction.java#L67-L69

Also tested manually with POST /_async_search

pquentin · 2025-09-09T13:10:15Z

specification/ilm/migrate_to_data_tiers/Request.ts

 master_timeout?: Duration
 }
- body: {
+ body?: {


https://github.com/elastic/elasticsearch/blob/3d2d765a1d6e99deda88603b6024bdc2f36599c2/x-pack/plugin/ilm/src/main/java/org/elasticsearch/xpack/ilm/action/RestMigrateToDataTiersAction.java#L39-L52

pquentin · 2025-09-09T13:11:21Z

specification/indices/put_alias/IndicesPutAliasRequest.ts

 timeout?: Duration
 }
- body: {
+ body?: {


https://github.com/elastic/elasticsearch/blob/3d2d765a1d6e99deda88603b6024bdc2f36599c2/server/src/main/java/org/elasticsearch/rest/action/admin/indices/RestIndexPutAliasAction.java#L66

pquentin · 2025-09-09T13:12:07Z

specification/indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts

+ /** @codegen_name index_template */
+ body?: IndexTemplate


https://github.com/elastic/elasticsearch/blob/63840f1276b1fea156a96a6ae16380c381982900/server/src/main/java/org/elasticsearch/rest/action/admin/indices/RestSimulateIndexTemplateAction.java#L50-L61

This fixes a YAML test: https://github.com/elastic/elasticsearch/blob/63840f1276b1fea156a96a6ae16380c381982900/modules/data-streams/src/yamlRestTest/resources/rest-api-spec/test/data_stream/230_data_stream_options.yml#L173-L176

pquentin · 2025-09-09T13:25:03Z

specification/watcher/execute_watch/WatcherExecuteWatchRequest.ts

 debug?: boolean
 }
- body: {
+ body?: {


https://github.com/elastic/elasticsearch/blob/bcb0222c9c101b2be51f98e0597d73e9967378d7/x-pack/plugin/watcher/src/main/java/org/elasticsearch/xpack/watcher/rest/action/RestExecuteWatchAction.java#L91-L93

pquentin · 2025-09-09T13:25:24Z

specification/watcher/query_watches/WatcherQueryWatchesRequest.ts

 }
 ]
- body: {
+ body?: {


https://github.com/elastic/elasticsearch/blob/bcb0222c9c101b2be51f98e0597d73e9967378d7/x-pack/plugin/watcher/src/main/java/org/elasticsearch/xpack/watcher/rest/action/RestQueryWatchesAction.java#L36-L40

pquentin · 2025-09-09T13:26:19Z

specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts

 id?: Id
 }
- body: {
+ body?: {


https://github.com/elastic/elasticsearch/blob/bcb0222c9c101b2be51f98e0597d73e9967378d7/x-pack/plugin/ml/src/main/java/org/elasticsearch/xpack/ml/rest/dataframe/RestExplainDataFrameAnalyticsAction.java#L53-L70

pquentin · 2025-09-09T13:26:55Z

specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts

 include_defaults?: boolean
 }
- body: {
+ body?: {


https://github.com/elastic/elasticsearch/blob/bcb0222c9c101b2be51f98e0597d73e9967378d7/server/src/main/java/org/elasticsearch/rest/action/admin/indices/RestSimulateTemplateAction.java#L48-L59

pquentin · 2025-09-09T13:28:18Z

specification/indices/create_from/MigrateCreateFromRequest.ts

 }
 /** @codegen_name create_from */
- body: CreateFrom
+ body?: CreateFrom


https://github.com/elastic/elasticsearch/blob/bcb0222c9c101b2be51f98e0597d73e9967378d7/x-pack/plugin/migrate/src/main/java/org/elasticsearch/xpack/migrate/rest/RestCreateIndexFromSourceAction.java#L34-L40 and tested manually

qn895

ML & Transform changes LGTM

pquentin

Added two APIs which I initially thought required a body. The server code was unclear, but the YAML tests provided clarity.

pquentin · 2025-09-10T07:04:33Z

specification/snapshot/create/SnapshotCreateRequest.ts

 wait_for_completion?: boolean
 }
- body: {
+ body?: {


YAML test that creates a snapshot without a body: https://github.com/elastic/elasticsearch/blob/a82b5cfb0ff7d22b95c56a8e7dcd7c5f3ba4ff24/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/snapshot.create/10_basic.yml#L23-L27

https://github.com/elastic/elasticsearch/blob/a59c182f9f7e9d1bf3d6eecbc0e44f24ff91d053/server/src/main/java/org/elasticsearch/rest/action/admin/cluster/RestCreateSnapshotAction.java#L48 applyContentParser checks for body content

pquentin · 2025-09-10T07:04:56Z

specification/snapshot/restore/SnapshotRestoreRequest.ts

 wait_for_completion?: boolean
 }
- body: {
+ body?: {


YAML test that restores a snapshot without a body: https://github.com/elastic/elasticsearch/blob/a82b5cfb0ff7d22b95c56a8e7dcd7c5f3ba4ff24/modules/repository-gcs/src/yamlRestTest/resources/rest-api-spec/test/repository_gcs/20_repository.yml#L139-L144

https://github.com/elastic/elasticsearch/blob/a59c182f9f7e9d1bf3d6eecbc0e44f24ff91d053/server/src/main/java/org/elasticsearch/rest/action/admin/cluster/RestRestoreSnapshotAction.java#L50 applyContentParser checks for body content

l-trotta

LGTM, and thanks for the detailed comments @pquentin!

* Fix optional bodies * Mark snapshot.create/snapshot.restore bodies as optional too (cherry picked from commit 3348b2f)

* Fix optional bodies * Mark snapshot.create/snapshot.restore bodies as optional too (cherry picked from commit 3348b2f) Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>

Fix optional bodies

c3969df

pquentin requested review from a team as code owners September 9, 2025 13:09

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

pquentin commented Sep 9, 2025

View reviewed changes

pquentin added the backport 8.19 label Sep 9, 2025

pquentin requested a review from l-trotta September 9, 2025 13:29

qn895 approved these changes Sep 9, 2025

View reviewed changes

Mark snapshot.create/snapshot.restore bodies as optional too

c2fb23c

pquentin commented Sep 10, 2025

View reviewed changes

pquentin mentioned this pull request Sep 10, 2025

Generate Elasticsearch rest-api-spec from the Elasticsearch specification #5215

Open

l-trotta approved these changes Sep 10, 2025

View reviewed changes

pquentin added the backport 9.1 label Sep 10, 2025

pquentin merged commit 3348b2f into main Sep 10, 2025
10 checks passed

pquentin deleted the fix-optional-bodies branch September 10, 2025 11:55

github-actions bot pushed a commit that referenced this pull request Sep 10, 2025

Fix optional bodies (#5271)

4f4a62e

* Fix optional bodies * Mark snapshot.create/snapshot.restore bodies as optional too (cherry picked from commit 3348b2f)

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

[Backport 8.19] Fix optional bodies #5272

Merged

github-actions bot pushed a commit that referenced this pull request Sep 10, 2025

Fix optional bodies (#5271)

1ffa425

* Fix optional bodies * Mark snapshot.create/snapshot.restore bodies as optional too (cherry picked from commit 3348b2f)

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

[Backport 9.1] Fix optional bodies #5273

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix optional bodies #5271

Fix optional bodies #5271

Uh oh!

pquentin commented Sep 9, 2025

github-actions bot commented Sep 9, 2025 •

edited

Loading

pquentin left a comment

pquentin Sep 9, 2025

pquentin Sep 9, 2025

pquentin Sep 9, 2025

pquentin Sep 9, 2025

pquentin Sep 9, 2025

pquentin Sep 9, 2025

pquentin Sep 9, 2025

pquentin Sep 9, 2025

pquentin Sep 9, 2025

pquentin Sep 9, 2025

qn895 left a comment

pquentin left a comment

pquentin Sep 10, 2025

l-trotta Sep 10, 2025

pquentin Sep 10, 2025

l-trotta Sep 10, 2025

l-trotta left a comment

Uh oh!

Labels

3 participants

Fix optional bodies #5271

Fix optional bodies #5271

Uh oh!

Conversation

pquentin commented Sep 9, 2025

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

Uh oh!

pquentin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qn895 left a comment

Choose a reason for hiding this comment

pquentin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

l-trotta left a comment

Choose a reason for hiding this comment

Uh oh!

Labels

3 participants

github-actions bot commented Sep 9, 2025 •

edited

Loading