Adding rest actions for getting and updating data stream mappings #130241
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
masseyke
added
>non-issue
:Data Management/Data streams
elasticsearchmachine
added
the
Team:Data Management
Collaborator
|
Pinging @elastic/es-data-management (Team:Data Management) |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds REST endpoints and support for retrieving and updating data stream mappings in Elasticsearch, gated behind the logs_stream feature flag.
- Introduces
GetDataStreamMappingsActionandUpdateDataStreamMappingsActionserver actions and their REST handlers - Adds corresponding REST API specifications (
indices.get_data_stream_mappings.json,indices.put_data_stream_mappings.json) - Implements YAML integration tests and registers handlers in the plugin under the feature flag
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| server/src/main/java/org/elasticsearch/action/datastreams/GetDataStreamMappingsAction.java | Fixes mapping conversion to always use JSON |
| rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_mappings.json | Adds PUT API spec for updating data stream mappings |
| rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream_mappings.json | Adds GET API spec for retrieving data stream mappings |
| modules/data-streams/src/yamlRestTest/resources/rest-api-spec/test/data_stream/250_data_stream_mappings.yml | New YAML tests covering get/put data stream mappings |
| modules/data-streams/src/yamlRestTest/java/org/elasticsearch/datastreams/DataStreamsClientYamlTestSuiteIT.java | Enables logs_stream feature flag in test cluster setup |
| modules/data-streams/src/main/java/org/elasticsearch/datastreams/rest/RestUpdateDataStreamMappingsAction.java | Implements REST handler for updating mappings |
| modules/data-streams/src/main/java/org/elasticsearch/datastreams/rest/RestGetDataStreamMappingsAction.java | Implements REST handler for retrieving mappings |
| modules/data-streams/src/main/java/org/elasticsearch/datastreams/DataStreamsPlugin.java | Registers new REST handlers under the logs_stream flag |
Comments suppressed due to low confidence (3)
modules/data-streams/src/main/java/org/elasticsearch/datastreams/rest/RestGetDataStreamMappingsAction.java:32
- There's a typo in the handler name. It should return "get_data_stream_mappings_action" to match naming conventions and avoid confusion.
return "gett_data_stream_mappings_action";
rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_mappings.json:44
- [nitpick] The
bodysection currently only has a description; adding a schema (e.g., expectedpropertiesstructure) would improve API spec clarity for consumers.
"body":{
server/src/main/java/org/elasticsearch/action/datastreams/GetDataStreamMappingsAction.java:132
- [nitpick] Hardcoding JSON here may lead to mismatches if the response builder uses a different content type (e.g., YAML or SMILE). Consider reverting to
builder.contentType()or documenting why JSON-only is intended.
XContentType.JSON
lukewhiting
approved these changes
Jun 30, 2025
Contributor
lukewhiting
left a comment
lukewhiting
left a comment
There was a problem hiding this comment.
One small typo and a question more than a change request so overall LGTM 👍
| public class RestGetDataStreamMappingsAction extends BaseRestHandler { | ||
| @Override | ||
| public String getName() { | ||
| return "gett_data_stream_mappings_action"; |
Contributor
There was a problem hiding this comment.
Typo?
Suggested change
| return "gett_data_stream_mappings_action"; | |
| return "get_data_stream_mappings_action"; |
Comment on lines
47
to
58
| try (XContentParser parser = request.contentParser()) { | ||
| XContentParser.Token token = parser.nextToken(); | ||
| if (token == XContentParser.Token.VALUE_STRING) { | ||
| mappings = new CompressedXContent(Base64.getDecoder().decode(parser.text())); | ||
| } else if (token == XContentParser.Token.VALUE_EMBEDDED_OBJECT) { | ||
| mappings = new CompressedXContent(parser.binaryValue()); | ||
| } else if (token == XContentParser.Token.START_OBJECT) { | ||
| mappings = new CompressedXContent(Strings.toString(XContentFactory.jsonBuilder().map(parser.mapOrdered()))); | ||
| } else { | ||
| throw new IllegalArgumentException("Unexpected token: " + token); | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
This seems to be a pretty common pattern. Any reason a utility method hasn't been created for it?
Member
Author
There was a problem hiding this comment.
Yeah good point. I moved it into a method in Template.
mridula-s109
pushed a commit
to mridula-s109/elasticsearch
that referenced
this pull request
Jul 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This builds on #129787 and #130042 and by adding the REST actions to allow users to get and update data stream mappings.