Adding specification for the new data stream settings APIs

[masseyke]

This adds specifications for the new data stream settings APIs.

[JoshMock]

This is the only URL in this whole file that links to a docs v2 page. @lcawl @georgewallace Does this need to be changed?

[masseyke]

I had just put in the placeholder we had used on the elasticsearch side. I can change it to something else. Looking now to see what fits best.

[lcawl]

I've added a lot of minor suggestions, but the important one is related to the @doc_tag. It would also be nice to have request and response examples per https://github.com/elastic/elasticsearch-specification/blob/main/docs/add-new-api.md#add-endpoint-request-and-response-examples

[github-actions]

Following you can find the validation results for the APIs you have changed.

API	Status	Request	Response
indices.add_block	🟢	2/2	2/2
indices.analyze	🟢	246/246	246/246
indices.cancel_migrate_reindex	🟢	2/2	2/2
indices.clear_cache	🟢	4/4	4/4
indices.clone	🟢	5/5	5/5
indices.close	🟢	49/49	49/49
indices.create_data_stream	🟢	31/31	31/31
indices.create_from	🟢	4/4	4/4
indices.create	🔴	1179/1230	1230/1230
indices.data_streams_stats	🟢	4/4	4/4
indices.delete_alias	🔴	12/12	5/12
indices.delete_data_lifecycle	⚪	Missing test	Missing test
indices.delete_data_stream_options	⚪	Missing test	Missing test
indices.delete_data_stream	🟢	28/28	28/28
indices.delete_index_template	🟢	1/1	1/1
indices.delete_template	🟢	9/9	9/9
indices.delete	🟢	105/105	105/105
indices.disk_usage	🟢	6/6	6/6
indices.downsample	🟢	4/4	4/4
indices.exists_alias	🟢	37/37	37/37
indices.exists_index_template	⚪	Missing test	Missing test
indices.exists_template	🟢	15/15	15/15
indices.exists	🟢	39/39	39/39
indices.explain_data_lifecycle	⚪	Missing test	Missing test
indices.field_usage_stats	🟢	5/5	5/5
indices.flush	🟢	41/41	41/41
indices.forcemerge	🟢	12/12	12/12
indices.get_alias	🟢	68/68	68/68
indices.get_data_lifecycle_stats	⚪	Missing test	Missing test
indices.get_data_lifecycle	⚪	Missing test	Missing test
indices.get_data_stream_options	⚪	Missing test	Missing test
indices.get_data_stream_settings	⚪	Missing test	Missing test
indices.get_data_stream	🟢	11/11	11/11
indices.get_field_mapping	🟢	15/15	15/15
indices.get_index_template	🟢	21/21	21/21
indices.get_mapping	🔴	144/144	142/144
indices.get_migrate_reindex_status	🟢	1/1	1/1
indices.get_settings	🔴	76/76	57/76
indices.get_template	🟢	32/32	32/32
indices.get	🟢	55/55	55/55
indices.migrate_reindex	🟢	2/2	2/2
indices.migrate_to_data_stream	⚪	Missing test	Missing test
indices.modify_data_stream	⚪	Missing test	Missing test
indices.open	🟢	20/20	20/20
indices.promote_data_stream	⚪	Missing test	Missing test
indices.put_alias	🔴	58/58	20/58
indices.put_data_lifecycle	⚪	Missing test	Missing test
indices.put_data_stream_options	⚪	Missing test	Missing test
indices.put_data_stream_settings	⚪	Missing test	Missing test
indices.put_index_template	🟢	68/68	68/68
indices.put_mapping	🔴	124/128	131/131
indices.put_settings	🔴	56/58	58/58
indices.put_template	🔴	45/46	46/46
indices.recovery	🟢	9/9	9/9
indices.refresh	🟢	283/283	283/283
indices.reload_search_analyzers	🟢	2/2	2/2
indices.resolve_cluster	🟢	13/13	13/13
indices.resolve_index	🟢	6/6	6/6
indices.rollover	🔴	27/27	2/27
indices.segments	🔴	6/6	5/6
indices.shard_stores	🔴	5/5	4/5
indices.shrink	🟢	5/5	5/5
indices.simulate_index_template	🔴	6/7	5/7
indices.simulate_template	🔴	5/5	4/5
indices.split	🟢	11/11	11/11
indices.stats	🔴	123/123	30/122
indices.update_aliases	🔴	26/26	7/26
indices.validate_query	🟢	12/12	12/12

You can validate these APIs yourself by using the make validate target.

[github-actions]

Following you can find the validation results for the APIs you have changed.

API	Status	Request	Response
indices.add_block	🟢	2/2	2/2
indices.analyze	🟢	246/246	246/246
indices.cancel_migrate_reindex	🟢	2/2	2/2
indices.clear_cache	🟢	4/4	4/4
indices.clone	🟢	5/5	5/5
indices.close	🟢	49/49	49/49
indices.create_data_stream	🟢	31/31	31/31
indices.create_from	🟢	4/4	4/4
indices.create	🔴	1179/1230	1230/1230
indices.data_streams_stats	🟢	4/4	4/4
indices.delete_alias	🔴	12/12	5/12
indices.delete_data_lifecycle	⚪	Missing test	Missing test
indices.delete_data_stream_options	⚪	Missing test	Missing test
indices.delete_data_stream	🟢	28/28	28/28
indices.delete_index_template	🟢	1/1	1/1
indices.delete_template	🟢	9/9	9/9
indices.delete	🟢	105/105	105/105
indices.disk_usage	🟢	6/6	6/6
indices.downsample	🟢	4/4	4/4
indices.exists_alias	🟢	37/37	37/37
indices.exists_index_template	⚪	Missing test	Missing test
indices.exists_template	🟢	15/15	15/15
indices.exists	🟢	39/39	39/39
indices.explain_data_lifecycle	⚪	Missing test	Missing test
indices.field_usage_stats	🟢	5/5	5/5
indices.flush	🟢	41/41	41/41
indices.forcemerge	🟢	12/12	12/12
indices.get_alias	🟢	68/68	68/68
indices.get_data_lifecycle_stats	⚪	Missing test	Missing test
indices.get_data_lifecycle	⚪	Missing test	Missing test
indices.get_data_stream_options	⚪	Missing test	Missing test
indices.get_data_stream_settings	⚪	Missing test	Missing test
indices.get_data_stream	🟢	11/11	11/11
indices.get_field_mapping	🟢	15/15	15/15
indices.get_index_template	🟢	21/21	21/21
indices.get_mapping	🔴	144/144	142/144
indices.get_migrate_reindex_status	🟢	1/1	1/1
indices.get_settings	🔴	76/76	57/76
indices.get_template	🟢	32/32	32/32
indices.get	🟢	55/55	55/55
indices.migrate_reindex	🟢	2/2	2/2
indices.migrate_to_data_stream	⚪	Missing test	Missing test
indices.modify_data_stream	⚪	Missing test	Missing test
indices.open	🟢	20/20	20/20
indices.promote_data_stream	⚪	Missing test	Missing test
indices.put_alias	🔴	58/58	20/58
indices.put_data_lifecycle	⚪	Missing test	Missing test
indices.put_data_stream_options	⚪	Missing test	Missing test
indices.put_data_stream_settings	⚪	Missing test	Missing test
indices.put_index_template	🟢	68/68	68/68
indices.put_mapping	🔴	124/128	131/131
indices.put_settings	🔴	56/58	58/58
indices.put_template	🔴	45/46	46/46
indices.recovery	🟢	9/9	9/9
indices.refresh	🟢	283/283	283/283
indices.reload_search_analyzers	🟢	2/2	2/2
indices.resolve_cluster	🟢	13/13	13/13
indices.resolve_index	🟢	6/6	6/6
indices.rollover	🔴	27/27	2/27
indices.segments	🔴	6/6	5/6
indices.shard_stores	🔴	5/5	4/5
indices.shrink	🟢	5/5	5/5
indices.simulate_index_template	🔴	6/7	5/7
indices.simulate_template	🔴	5/5	4/5
indices.split	🟢	11/11	11/11
indices.stats	🔴	123/123	30/122
indices.update_aliases	🔴	26/26	7/26
indices.validate_query	🟢	12/12	12/12

You can validate these APIs yourself by using the make validate target.

[lcawl]

I added a few more minor suggestions related to changes in the way we're generating examples and annotating availability, but otherwise LGTM

[github-actions]

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