Adding specification for the new data stream mappings API #4751
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
specification
compiler
skip-backport
|
Following you can find the validation changes for the APIs you have modified.
You can validate these APIs yourself by using the |
pquentin
reviewed
Jul 4, 2025
Comment on lines
+2
to
+24
| alternatives: | ||
| - language: Python | ||
| code: |- | ||
| resp = client.indices.get_data_stream_mappings( | ||
| name="my-data-stream", | ||
| ) | ||
| - language: JavaScript | ||
| code: |- | ||
| const response = await client.indices.getDataStreamSettings({ | ||
| name: "my-data-stream", | ||
| }); | ||
| - language: Ruby | ||
| code: |- | ||
| response = client.indices.get_data_stream_mappings( | ||
| name: "my-data-stream" | ||
| ) | ||
| - language: PHP | ||
| code: |- | ||
| $resp = $client->indices()->getDataStreamSettings([ | ||
| "name" => "my-data-stream", | ||
| ]); | ||
| - language: curl | ||
| code: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_data_stream/my-data-stream/_mappings"' |
There was a problem hiding this comment.
All the alternatives are generated. However a summary (and description if needed) would help.
Comment on lines
+17
to
+82
| alternatives: | ||
| - language: Python | ||
| code: |- | ||
| resp = client.indices.put_data_stream_mappings( | ||
| name="my-data-stream", | ||
| mappings={ | ||
| "properties":{ | ||
| "field1":{ | ||
| "type":"ip" | ||
| }, | ||
| "field3":{ | ||
| "type":"text" | ||
| } | ||
| } | ||
| }, | ||
| ) | ||
| - language: JavaScript | ||
| code: |- | ||
| const response = await client.indices.putDataStreamSettings({ | ||
| name: "my-data-stream", | ||
| mappings: { | ||
| "properties":{ | ||
| "field1":{ | ||
| "type":"ip" | ||
| }, | ||
| "field3":{ | ||
| "type":"text" | ||
| } | ||
| } | ||
| }, | ||
| }); | ||
| - language: Ruby | ||
| code: |- | ||
| response = client.indices.put_data_stream_mappings( | ||
| name: "my-data-stream", | ||
| body: { | ||
| "properties":{ | ||
| "field1":{ | ||
| "type":"ip" | ||
| }, | ||
| "field3":{ | ||
| "type":"text" | ||
| } | ||
| } | ||
| } | ||
| ) | ||
| - language: PHP | ||
| code: |- | ||
| $resp = $client->indices()->putDataStreamSettings([ | ||
| "name" => "my-data-stream", | ||
| "body" => [ | ||
| "properties" => [ | ||
| "field1" => [ | ||
| "type" => "ip" | ||
| ], | ||
| "field3" => [ | ||
| "type" => "text" | ||
| ] | ||
| ] | ||
| ], | ||
| ]); | ||
| - language: curl | ||
| code: | ||
| 'curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d | ||
| ''{"index.lifecycle.name":"new-test-policy","index.number_of_shards":11}'' | ||
| "$ELASTICSEARCH_URL/_data_stream/my-data-stream/_mappings"' |
There was a problem hiding this comment.
Sorry that you took the time to do this, but it's generated.
Comment on lines
+5
to
+6
| # type: response | ||
| # response_code: 200 |
There was a problem hiding this comment.
I think this can be uncommented. Not too familiar with examples to be honest. (I do appreciate that you worked on them!)
Suggested change
| # type: response | |
| # response_code: 200 | |
| type: response | |
| response_code: 200 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 adds specifications for the new data stream mappings APIs.