Skip to content

Fix optional bodies #5271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 10, 2025
Merged

Fix optional bodies #5271

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3969df
Fix optional bodies
pquentin Sep 9, 2025
c2fb23c
Mark snapshot.create/snapshot.restore bodies as optional too
pquentin Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion specification/snapshot/create/SnapshotCreateRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export interface Request extends RequestBase {
*/
wait_for_completion?: boolean
}
body: {
body?: {
Copy link
Member Author

@pquentin pquentin Sep 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

@l-trotta l-trotta Sep 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

/**
* Determines how wildcard patterns in the `indices` parameter match data streams and indices.
* It supports comma-separated values such as `open,hidden`.
Expand Down
2 changes: 1 addition & 1 deletion specification/snapshot/restore/SnapshotRestoreRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ export interface Request extends RequestBase {
*/
wait_for_completion?: boolean
}
body: {
body?: {
Copy link
Member Author

@pquentin pquentin Sep 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

@l-trotta l-trotta Sep 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

/**
* The feature states to restore.
* If `include_global_state` is `true`, the request restores all feature states in the snapshot by default.
Expand Down