elastic / elasticsearch-specification

Elasticsearch full specification
Apache License 2.0
111 stars 68 forks source link

[DOCS] Add operation summaries for data stream APIs #2711

Closed shainaraskas closed 2 weeks ago

shainaraskas commented 3 weeks ago

This PR adds operation summaries for the data stream and data stream lifecycle APIs, using text from the appropriate pages from the elasticsearch API reference.

A couple of terminology fixes for data streams in the types area while I'm here as well

part of https://github.com/elastic/elasticsearch-specification/issues/2635

github-actions[bot] commented 3 weeks ago

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

API Status Request Response
indices.add_block :green_circle: 2/2 2/2
indices.analyze :green_circle: 20/20 20/20
indices.clear_cache :green_circle: 4/4 4/4
indices.clone :green_circle: 5/5 5/5
indices.close :green_circle: 50/50 50/50
indices.create_data_stream :green_circle: 28/28 28/28
indices.create :red_circle: 916/957 957/957
indices.data_streams_stats :green_circle: 4/4 4/4
indices.delete_alias :red_circle: 15/15 5/15
indices.delete_data_lifecycle :white_circle: Missing test Missing test
indices.delete_data_stream :green_circle: 28/28 28/28
indices.delete_index_template :green_circle: 1/1 1/1
indices.delete_template :green_circle: 9/9 9/9
indices.delete :green_circle: 105/105 105/105
indices.disk_usage :green_circle: 5/5 5/5
indices.downsample :green_circle: 1/1 1/1
indices.exists_alias :green_circle: 38/38 38/38
indices.exists_index_template :white_circle: Missing test Missing test
indices.exists_template :green_circle: 15/15 15/15
indices.exists :green_circle: 39/39 39/39
indices.explain_data_lifecycle :white_circle: Missing test Missing test
indices.field_usage_stats :green_circle: 5/5 5/5
indices.flush :green_circle: 30/30 30/30
indices.forcemerge :red_circle: 12/12 11/12
indices.get_alias :red_circle: 86/86 74/86
indices.get_data_lifecycle :white_circle: Missing test Missing test
indices.get_data_stream :red_circle: 12/12 3/12
indices.get_field_mapping :red_circle: 15/15 14/15
indices.get_index_template :red_circle: 19/19 15/19
indices.get_mapping :red_circle: 121/121 109/121
indices.get_settings :red_circle: 61/61 59/61
indices.get_template :green_circle: 30/30 30/30
indices.get :green_circle: 53/53 53/53
indices.migrate_to_data_stream :white_circle: Missing test Missing test
indices.modify_data_stream :white_circle: Missing test Missing test
indices.open :green_circle: 18/18 18/18
indices.promote_data_stream :white_circle: Missing test Missing test
indices.put_alias :red_circle: 59/59 20/59
indices.put_data_lifecycle :white_circle: Missing test Missing test
indices.put_index_template :red_circle: 50/52 52/52
indices.put_mapping :red_circle: 75/103 103/103
indices.put_settings :red_circle: 54/57 57/57
indices.put_template :red_circle: 44/49 49/49
indices.recovery :green_circle: 9/9 9/9
indices.refresh :green_circle: 265/265 265/265
indices.reload_search_analyzers :green_circle: 2/2 2/2
indices.resolve_cluster :red_circle: 10/12 12/12
indices.resolve_index :green_circle: 6/6 6/6
indices.rollover :red_circle: 26/26 1/26
indices.segments :red_circle: 6/6 5/6
indices.shard_stores :red_circle: 5/5 4/5
indices.shrink :green_circle: 5/5 5/5
indices.simulate_index_template :red_circle: 6/7 5/7
indices.simulate_template :red_circle: 5/5 4/5
indices.split :green_circle: 11/11 11/11
indices.stats :red_circle: 103/103 31/102
indices.unfreeze :green_circle: 1/1 1/1
indices.update_aliases :red_circle: 26/26 7/26
indices.validate_query :green_circle: 7/7 7/7

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