[Rest Compatible Api] include_type_name parameter (#70966)

This commit allows to use the include_type_name parameter with the compatible rest api.
The support for include_type_name was previously removed in #48632

relates #51816
types removal meta issue #54160

Author: pgomulka

rest-api-spec/build.gradle

@@ -146,11 +146,9 @@ tasks.named("yamlRestCompatTest").configure {
     'explain/21_source_filtering_with_types/Source filtering',
     'explain/31_query_string_with_types/explain with query_string parameters',
     'explain/40_mix_typeless_typeful/Explain with typeless API on an index that has types',
-    'field_caps/10_basic/Get date_nanos field caps',
     'field_caps/30_filter/Field caps with index filter',
-    'get/100_mix_typeless_typeful/GET with typeless API on an index that has types',// failing due to include_type_name #48632
-    'get/21_stored_fields_with_types/Stored fields', // failing due to include_type_name #48632
-    'get/71_source_filtering_with_types/Source filtering',// failing due to include_type_name #48632
+    // WILL NOT BE FIXED - failing due to not recognising missing type (the type path param is ignored)
+    'get/100_mix_typeless_typeful/GET with typeless API on an index that has types',
     'get_source/11_basic_with_types/Basic with types',
     'get_source/16_default_values_with_types/Default values',
     'get_source/41_routing_with_types/Routing',
@@ -160,43 +158,35 @@ tasks.named("yamlRestCompatTest").configure {
     'get_source/81_missing_with_types/Missing document with ignore',
     'get_source/86_source_missing_with_types/Missing document source with catch',
     'get_source/86_source_missing_with_types/Missing document source with ignore',
-    'index/70_mix_typeless_typeful/Index call that introduces new field mappings', // failing due to include_type_name #48632
-    'index/70_mix_typeless_typeful/Index with typeless API on an index that has types', // failing due to include_type_name #48632
     'indices.clone/10_basic/Clone index via API',
-    'indices.create/10_basic/Create index with explicit _doc type',
     'indices.create/10_basic/Create index without soft deletes',
-    'indices.create/11_basic_with_types/Create index',
-    'indices.create/11_basic_with_types/Create index with aliases',
+    // 5 below await retrofitting Removes typed URLs from mapping APIs #41676
     'indices.create/11_basic_with_types/Create index with mappings',
-    'indices.create/11_basic_with_types/Create index with settings',
-    'indices.create/11_basic_with_types/Create index with wait_for_active_shards set to all',
-    'indices.create/11_basic_with_types/Create index with write aliases',
     'indices.create/20_mix_typeless_typeful/Create a typed index while there is a typeless template',
     'indices.create/20_mix_typeless_typeful/Create a typeless index while there is a typed template',
     'indices.create/20_mix_typeless_typeful/Implicitly create a typed index while there is a typeless template',
     'indices.create/20_mix_typeless_typeful/Implicitly create a typeless index while there is a typed template',
+    //
     'indices.flush/10_basic/Flush stats',
     'indices.flush/10_basic/Index synced flush rest test',
     'indices.forcemerge/10_basic/Check deprecation warning when incompatible only_expunge_deletes and max_num_segments values are both set',
-    'indices.get/11_basic_with_types/Test include_type_name',
-    'indices.get/11_basic_with_types/Test include_type_name dafaults to false',
-    'indices.get_field_mapping/10_basic/Get field mapping with local is deprecated',
-    'indices.get_field_mapping/11_basic_with_types/Get field mapping by index only',
-    'indices.get_field_mapping/11_basic_with_types/Get field mapping by type & field',
-    'indices.get_field_mapping/11_basic_with_types/Get field mapping by type & field, with another field that doesn\'t exist',
-    'indices.get_field_mapping/11_basic_with_types/Get field mapping should work without index specifying type and fields',
-    'indices.get_field_mapping/11_basic_with_types/Get field mapping with include_defaults',
-    'indices.get_field_mapping/11_basic_with_types/Get field mapping with no index and type',
-    'indices.get_field_mapping/21_missing_field_with_types/Return empty object if field doesn\'t exist, but type and index do',
-    'indices.get_field_mapping/30_missing_type/Raise 404 when type doesn\'t exist',
-    'indices.get_field_mapping/51_field_wildcards_with_types/Get field mapping should work using \'*\' for indices and types',
-    'indices.get_field_mapping/51_field_wildcards_with_types/Get field mapping should work using \'_all\' for indices and types',
-    'indices.get_field_mapping/51_field_wildcards_with_types/Get field mapping should work using comma_separated values for indices and types',
-    'indices.get_field_mapping/51_field_wildcards_with_types/Get field mapping with * for fields',
-    'indices.get_field_mapping/51_field_wildcards_with_types/Get field mapping with *t1 for fields',
-    'indices.get_field_mapping/51_field_wildcards_with_types/Get field mapping with t* for fields',
-    'indices.get_field_mapping/51_field_wildcards_with_types/Get field mapping with wildcarded relative names',
-    'indices.get_field_mapping/60_mix_typeless_typeful/GET mapping with typeless API on an index that has types',
+    'indices.get_field_mapping/10_basic/Get field mapping with local is deprecated',// awaits #41676
+    'indices.get_field_mapping/11_basic_with_types/Get field mapping by index only',// awaits #41676
+    'indices.get_field_mapping/11_basic_with_types/Get field mapping by type & field',// awaits #41676
+    'indices.get_field_mapping/11_basic_with_types/Get field mapping by type & field, with another field that doesn\'t exist',// awaits #41676
+    'indices.get_field_mapping/11_basic_with_types/Get field mapping should work without index specifying type and fields',// awaits #41676
+    'indices.get_field_mapping/11_basic_with_types/Get field mapping with include_defaults',// awaits #41676
+    'indices.get_field_mapping/11_basic_with_types/Get field mapping with no index and type',// awaits #41676
+    'indices.get_field_mapping/21_missing_field_with_types/Return empty object if field doesn\'t exist, but type and index do',// awaits #41676
+    'indices.get_field_mapping/30_missing_type/Raise 404 when type doesn\'t exist',// awaits #41676
+    'indices.get_field_mapping/51_field_wildcards_with_types/Get field mapping should work using \'*\' for indices and types',// awaits #41676
+    'indices.get_field_mapping/51_field_wildcards_with_types/Get field mapping should work using \'_all\' for indices and types',// awaits #41676
+    'indices.get_field_mapping/51_field_wildcards_with_types/Get field mapping should work using comma_separated values for indices and types',// awaits #41676
+    'indices.get_field_mapping/51_field_wildcards_with_types/Get field mapping with * for fields',// awaits #41676
+    'indices.get_field_mapping/51_field_wildcards_with_types/Get field mapping with *t1 for fields',// awaits #41676
+    'indices.get_field_mapping/51_field_wildcards_with_types/Get field mapping with t* for fields',// awaits #41676
+    'indices.get_field_mapping/51_field_wildcards_with_types/Get field mapping with wildcarded relative names',// awaits #41676
+    'indices.get_field_mapping/60_mix_typeless_typeful/GET mapping with typeless API on an index that has types',// awaits #41676
     'indices.get_mapping/11_basic_with_types/Get /*/_mapping/{type}',
     'indices.get_mapping/11_basic_with_types/Get /_all/_mapping/{type}',
     'indices.get_mapping/11_basic_with_types/Get /_mapping',
@@ -217,8 +207,6 @@ tasks.named("yamlRestCompatTest").configure {
     'indices.get_mapping/40_aliases/Getting mapping for aliases should return the real index as key',
     'indices.get_mapping/61_empty_with_types/Check empty mapping when getting all mappings via /_mapping',
     'indices.get_mapping/70_mix_typeless_typeful/GET mapping with typeless API on an index that has types',
-    'indices.get_template/11_basic_with_types/Get template',
-    'indices.get_template/11_basic_with_types/Get template with no mappings',
     'indices.open/10_basic/?wait_for_active_shards default is deprecated',
     'indices.open/10_basic/?wait_for_active_shards=index-setting',
     'indices.put_mapping/10_basic/Put mappings with explicit _doc type',
@@ -233,15 +221,9 @@ tasks.named("yamlRestCompatTest").configure {
     'indices.put_mapping/all_path_options_with_types/put mapping in prefix* index',
     'indices.put_mapping/all_path_options_with_types/put mapping with blank index',
     'indices.put_mapping/all_path_options_with_types/put one mapping per index',
-    'indices.put_template/10_basic/Put template with explicit _doc type',
-    'indices.put_template/11_basic_with_types/Put multiple template',
-    'indices.put_template/11_basic_with_types/Put template',
+    // there is a small distinction between empty mappings and no mappings at all. The code to implement this test was refactored #54003
+    // not fixing this in #70966
     'indices.put_template/11_basic_with_types/Put template with empty mappings',
-    'indices.rollover/10_basic/Rollover index via API',
-    'indices.rollover/20_max_doc_condition/Max docs rollover conditions matches only primary shards',
-    'indices.rollover/30_max_size_condition/Rollover with max_size condition',
-    'indices.rollover/40_mapping/Mappings with explicit _doc type',
-    'indices.rollover/41_mapping_with_types/Typeless mapping',
     'indices.segments/10_basic/basic segments test',
     'indices.segments/10_basic/closed segments test',
     'indices.shard_stores/10_basic/basic index test',
@@ -302,8 +284,6 @@ tasks.named("yamlRestCompatTest").configure {
     'search.aggregation/10_histogram/Deprecated _time order',
     'search.aggregation/200_top_hits_metric/top_hits aggregation with sequence numbers',
     'search.aggregation/20_terms/Deprecated _term order',
-    'search.aggregation/280_geohash_grid/Basic test',
-    'search.aggregation/290_geotile_grid/Basic test',
     'search.aggregation/51_filter_with_types/Filter aggs with terms lookup and ensure it\'s cached',
     'search.inner_hits/10_basic/Nested doc version and seqIDs',
     'search.inner_hits/10_basic/Nested inner hits',
@@ -363,6 +343,9 @@ tasks.named("transformV7RestTests").configure({ task ->
   task.replaceMatch("nodes.\$node_id.roles.8", "ml", "node_info role test")
   task.replaceMatch("nodes.\$node_id.roles.9", "remote_cluster_client", "node_info role test")
   task.removeMatch("nodes.\$node_id.roles.10", "node_info role test")
+  task.replaceIsTrue("test_index.mappings.type_1", "test_index.mappings._doc")
+  task.replaceIsFalse("test_index.mappings.type_1", "test_index.mappings._doc")
+  task.replaceIsFalse("test-1.mappings.my_type", "test-1.mappings._doc")
 })
 
 tasks.register('enforceYamlTestConvention').configure {

server/src/main/java/org/elasticsearch/action/admin/indices/get/GetIndexResponse.java

@@ -12,6 +12,7 @@
 import org.elasticsearch.action.ActionResponse;
 import org.elasticsearch.cluster.metadata.AliasMetadata;
 import org.elasticsearch.cluster.metadata.MappingMetadata;
+import org.elasticsearch.common.RestApiVersion;
 import org.elasticsearch.common.Strings;
 import org.elasticsearch.common.collect.ImmutableOpenMap;
 import org.elasticsearch.common.io.stream.StreamInput;
@@ -26,6 +27,9 @@
 import java.util.List;
 import java.util.Objects;
 
+import static org.elasticsearch.rest.BaseRestHandler.DEFAULT_INCLUDE_TYPE_NAME_POLICY;
+import static org.elasticsearch.rest.BaseRestHandler.INCLUDE_TYPE_NAME_PARAMETER;
+
 /**
  * A response for a get index action.
  */
@@ -192,7 +196,14 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
                     if (indexMappings == null) {
                         builder.startObject("mappings").endObject();
                     } else {
-                        builder.field("mappings", indexMappings.sourceAsMap());
+                        if (builder.getRestApiVersion() == RestApiVersion.V_7 &&
+                            params.paramAsBoolean(INCLUDE_TYPE_NAME_PARAMETER, DEFAULT_INCLUDE_TYPE_NAME_POLICY)) {
+                            builder.startObject("mappings");
+                            builder.field(MapperService.SINGLE_MAPPING_NAME, indexMappings.sourceAsMap());
+                            builder.endObject();
+                        } else {
+                            builder.field("mappings", indexMappings.sourceAsMap());
+                        }
                     }
 
                     builder.startObject("settings");

server/src/main/java/org/elasticsearch/action/admin/indices/mapping/get/GetFieldMappingsResponse.java

@@ -11,6 +11,7 @@
 import org.elasticsearch.Version;
 import org.elasticsearch.action.ActionResponse;
 import org.elasticsearch.common.ParseField;
+import org.elasticsearch.common.RestApiVersion;
 import org.elasticsearch.common.bytes.BytesReference;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
@@ -22,6 +23,7 @@
 import org.elasticsearch.common.xcontent.XContentType;
 import org.elasticsearch.index.mapper.Mapper;
 import org.elasticsearch.index.mapper.MapperService;
+import org.elasticsearch.rest.BaseRestHandler;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -30,6 +32,7 @@
 import java.util.Objects;
 
 import static java.util.Collections.unmodifiableMap;
+import static org.elasticsearch.rest.BaseRestHandler.DEFAULT_INCLUDE_TYPE_NAME_POLICY;
 
 /**
  * Response object for {@link GetFieldMappingsRequest} API
@@ -84,15 +87,23 @@ public FieldMappingMetadata fieldMappings(String index, String field) {
 
     @Override
     public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
+
         builder.startObject();
         for (Map.Entry<String, Map<String, FieldMappingMetadata>> indexEntry : mappings.entrySet()) {
             builder.startObject(indexEntry.getKey());
             builder.startObject(MAPPINGS.getPreferredName());
-
             if (indexEntry.getValue() != null) {
-                addFieldMappingsToBuilder(builder, params, indexEntry.getValue());
+                if (builder.getRestApiVersion() == RestApiVersion.V_7 &&
+                    params.paramAsBoolean(BaseRestHandler.INCLUDE_TYPE_NAME_PARAMETER, DEFAULT_INCLUDE_TYPE_NAME_POLICY)) {
+                    builder.startObject(MapperService.SINGLE_MAPPING_NAME);
+                    addFieldMappingsToBuilder(builder, params, indexEntry.getValue());
+                    builder.endObject();
+                } else {
+                    addFieldMappingsToBuilder(builder, params, indexEntry.getValue());
+                }
             }
 
+
             builder.endObject();
             builder.endObject();
         }

server/src/main/java/org/elasticsearch/action/admin/indices/rollover/RolloverRequest.java

@@ -14,6 +14,7 @@
 import org.elasticsearch.action.support.IndicesOptions;
 import org.elasticsearch.action.support.master.AcknowledgedRequest;
 import org.elasticsearch.common.ParseField;
+import org.elasticsearch.common.RestApiVersion;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
 import org.elasticsearch.common.unit.ByteSizeValue;
@@ -37,7 +38,7 @@
  */
 public class RolloverRequest extends AcknowledgedRequest<RolloverRequest> implements IndicesRequest {
 
-    private static final ObjectParser<RolloverRequest, Void> PARSER = new ObjectParser<>("rollover");
+    private static final ObjectParser<RolloverRequest, Boolean> PARSER = new ObjectParser<>("rollover");
     private static final ObjectParser<Map<String, Condition<?>>, Void> CONDITION_PARSER = new ObjectParser<>("conditions");
 
     private static final ParseField CONDITIONS = new ParseField("conditions");
@@ -67,14 +68,32 @@ public class RolloverRequest extends AcknowledgedRequest<RolloverRequest> implem
             CONDITIONS, ObjectParser.ValueType.OBJECT);
         PARSER.declareField((parser, request, context) -> request.createIndexRequest.settings(parser.map()),
             CreateIndexRequest.SETTINGS, ObjectParser.ValueType.OBJECT);
+        PARSER.declareField((parser, request, includeTypeName) -> {
+            if (includeTypeName) {
+                //expecting one type only
+                for (Map.Entry<String, Object> mappingsEntry : parser.map().entrySet()) {
+                    request.createIndexRequest.mapping((Map<String, Object>) mappingsEntry.getValue());
+                }
+            } else {
+                // a type is not included, add a dummy _doc type
+                Map<String, Object> mappings = parser.map();
+                if (MapperService.isMappingSourceTyped(MapperService.SINGLE_MAPPING_NAME, mappings)) {
+                    throw new IllegalArgumentException("The mapping definition cannot be nested under a type " +
+                        "[" + MapperService.SINGLE_MAPPING_NAME + "] unless include_type_name is set to true.");
+                }
+                request.createIndexRequest.mapping(mappings);
+            }
+        }, CreateIndexRequest.MAPPINGS.forRestApiVersion(RestApiVersion.equalTo(RestApiVersion.V_7)), ObjectParser.ValueType.OBJECT);
         PARSER.declareField((parser, request, context) -> {
             // a type is not included, add a dummy _doc type
             Map<String, Object> mappings = parser.map();
             if (MapperService.isMappingSourceTyped(MapperService.SINGLE_MAPPING_NAME, mappings)) {
+
                 throw new IllegalArgumentException("The mapping definition cannot be nested under a type");
             }
             request.createIndexRequest.mapping(mappings);
-        }, CreateIndexRequest.MAPPINGS, ObjectParser.ValueType.OBJECT);
+        }, CreateIndexRequest.MAPPINGS.forRestApiVersion(RestApiVersion.onOrAfter(RestApiVersion.V_8)), ObjectParser.ValueType.OBJECT);
+
         PARSER.declareField((parser, request, context) -> request.createIndexRequest.aliases(parser.map()),
             CreateIndexRequest.ALIASES, ObjectParser.ValueType.OBJECT);
     }
@@ -238,7 +257,7 @@ public CreateIndexRequest getCreateIndexRequest() {
     }
 
     // param isTypeIncluded decides how mappings should be parsed from XContent
-    public void fromXContent(XContentParser parser) throws IOException {
-        PARSER.parse(parser, this, null);
+    public void fromXContent(boolean isTypeIncluded, XContentParser parser) throws IOException {
+        PARSER.parse(parser, this, isTypeIncluded);
     }
 }

server/src/main/java/org/elasticsearch/action/admin/indices/template/get/GetIndexTemplatesResponse.java

@@ -9,6 +9,7 @@
 
 import org.elasticsearch.action.ActionResponse;
 import org.elasticsearch.cluster.metadata.IndexTemplateMetadata;
+import org.elasticsearch.common.RestApiVersion;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
 import org.elasticsearch.common.xcontent.ToXContent;
@@ -20,6 +21,7 @@
 import java.util.Objects;
 
 import static java.util.Collections.singletonMap;
+import static org.elasticsearch.rest.BaseRestHandler.INCLUDE_TYPE_NAME_PARAMETER;
 
 public class GetIndexTemplatesResponse extends ActionResponse implements ToXContentObject {
 
@@ -65,7 +67,12 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
 
         builder.startObject();
         for (IndexTemplateMetadata indexTemplateMetadata : getIndexTemplates()) {
-            IndexTemplateMetadata.Builder.toXContent(indexTemplateMetadata, builder, params);
+            if(builder.getRestApiVersion() == RestApiVersion.V_7 &&
+                params.paramAsBoolean(INCLUDE_TYPE_NAME_PARAMETER, false)) {
+                IndexTemplateMetadata.Builder.toXContentWithTypes(indexTemplateMetadata, builder, params);
+            } else {
+                IndexTemplateMetadata.Builder.toXContent(indexTemplateMetadata, builder, params);
+            }
         }
         builder.endObject();
         return builder;

server/src/main/java/org/elasticsearch/cluster/metadata/IndexTemplateMetadata.java

@@ -37,6 +37,10 @@
 import java.util.Objects;
 import java.util.Set;
 
+import static org.elasticsearch.common.RestApiVersion.V_8;
+import static org.elasticsearch.common.RestApiVersion.onOrAfter;
+
+
 public class IndexTemplateMetadata extends AbstractDiffable<IndexTemplateMetadata> {
 
     private final String name;
@@ -378,7 +382,9 @@ private static void toInnerXContent(IndexTemplateMetadata indexTemplateMetadata,
             indexTemplateMetadata.settings().toXContent(builder, params);
             builder.endObject();
 
-            includeTypeName &= (params.paramAsBoolean("reduce_mappings", false) == false);
+            if(builder.getRestApiVersion().matches(onOrAfter(V_8))) {
+                includeTypeName &= (params.paramAsBoolean("reduce_mappings", false) == false);
+            }
 
             CompressedXContent m = indexTemplateMetadata.mappings();
             if (m != null) {