[codegen] Update to latest API spec

Author: swallez

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/Conflicts.java

@@ -34,8 +34,14 @@
  */
 @JsonpDeserializable
 public enum Conflicts implements JsonEnum {
+	/**
+	 * Stop reindexing if there are conflicts.
+	 */
 	Abort("abort"),
 
+	/**
+	 * Continue reindexing even if there are conflicts.
+	 */
 	Proceed("proceed"),
 
 	;

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/GeoDistanceType.java

@@ -34,8 +34,14 @@
  */
 @JsonpDeserializable
 public enum GeoDistanceType implements JsonEnum {
+	/**
+	 * The <code>arc</code> calculation is the most accurate.
+	 */
 	Arc("arc"),
 
+	/**
+	 * The <code>plane</code> calculation is faster but less accurate.
+	 */
 	Plane("plane"),
 
 	;

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/LatLonGeoLocation.java

@@ -65,14 +65,18 @@ public static LatLonGeoLocation of(Function<Builder, ObjectBuilder<LatLonGeoLoca
 	}
 
 	/**
-	 * Required - API name: {@code lat}
+	 * Required - Latitude
+	 * <p>
+	 * API name: {@code lat}
 	 */
 	public final double lat() {
 		return this.lat;
 	}
 
 	/**
-	 * Required - API name: {@code lon}
+	 * Required - Longitude
+	 * <p>
+	 * API name: {@code lon}
 	 */
 	public final double lon() {
 		return this.lon;
@@ -114,15 +118,19 @@ public static class Builder extends WithJsonObjectBuilderBase<Builder> implement
 		private Double lon;
 
 		/**
-		 * Required - API name: {@code lat}
+		 * Required - Latitude
+		 * <p>
+		 * API name: {@code lat}
 		 */
 		public final Builder lat(double value) {
 			this.lat = value;
 			return this;
 		}
 
 		/**
-		 * Required - API name: {@code lon}
+		 * Required - Longitude
+		 * <p>
+		 * API name: {@code lon}
 		 */
 		public final Builder lon(double value) {
 			this.lon = value;

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/OpType.java

@@ -33,8 +33,14 @@
  */
 @JsonpDeserializable
 public enum OpType implements JsonEnum {
+	/**
+	 * Overwrite any documents that already exist.
+	 */
 	Index("index"),
 
+	/**
+	 * Only index documents that do not already exist.
+	 */
 	Create("create"),
 
 	;

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/SuggestMode.java

@@ -34,10 +34,20 @@
  */
 @JsonpDeserializable
 public enum SuggestMode implements JsonEnum {
+	/**
+	 * Only generate suggestions for terms that are not in the shard.
+	 */
 	Missing("missing"),
 
+	/**
+	 * Only suggest terms that occur in more docs on the shard than the original
+	 * term.
+	 */
 	Popular("popular"),
 
+	/**
+	 * Suggest any matching suggestions based on terms in the suggest text.
+	 */
 	Always("always"),
 
 	;

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/VersionType.java

@@ -34,10 +34,24 @@
  */
 @JsonpDeserializable
 public enum VersionType implements JsonEnum {
+	/**
+	 * Use internal versioning that starts at 1 and increments with each update or
+	 * delete.
+	 */
 	Internal("internal"),
 
+	/**
+	 * Only index the document if the given version is strictly higher than the
+	 * version of the stored document or if there is no existing document.
+	 */
 	External("external"),
 
+	/**
+	 * Only index the document if the given version is equal or higher than the
+	 * version of the stored document or if there is no existing document. Note: the
+	 * external_gte version type is meant for special use cases and should be used
+	 * with care. If used incorrectly, it can result in loss of data.
+	 */
 	ExternalGte("external_gte"),
 
 	Force("force"),

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/AggregationRange.java

@@ -72,6 +72,8 @@ public static AggregationRange of(Function<Builder, ObjectBuilder<AggregationRan
 	}
 
 	/**
+	 * Start of the range (inclusive).
+	 * <p>
 	 * API name: {@code from}
 	 */
 	@Nullable
@@ -80,6 +82,8 @@ public final String from() {
 	}
 
 	/**
+	 * Custom key to return the range with.
+	 * <p>
 	 * API name: {@code key}
 	 */
 	@Nullable
@@ -88,6 +92,8 @@ public final String key() {
 	}
 
 	/**
+	 * End of the range (exclusive).
+	 * <p>
 	 * API name: {@code to}
 	 */
 	@Nullable
@@ -146,6 +152,8 @@ public static class Builder extends WithJsonObjectBuilderBase<Builder> implement
 		private String to;
 
 		/**
+		 * Start of the range (inclusive).
+		 * <p>
 		 * API name: {@code from}
 		 */
 		public final Builder from(@Nullable String value) {
@@ -154,6 +162,8 @@ public final Builder from(@Nullable String value) {
 		}
 
 		/**
+		 * Custom key to return the range with.
+		 * <p>
 		 * API name: {@code key}
 		 */
 		public final Builder key(@Nullable String value) {
@@ -162,6 +172,8 @@ public final Builder key(@Nullable String value) {
 		}
 
 		/**
+		 * End of the range (exclusive).
+		 * <p>
 		 * API name: {@code to}
 		 */
 		public final Builder to(@Nullable String value) {

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/BoxplotAggregation.java

@@ -70,9 +70,9 @@ public Aggregation.Kind _aggregationKind() {
 	}
 
 	/**
-	 * Controls memory usage and approximation error by limiting the maximum number
-	 * of nodes used by the underlying TDigest algorithm to
-	 * <code>20 * compression</code>.
+	 * Limits the maximum number of nodes used by the underlying TDigest algorithm
+	 * to <code>20 * compression</code>, enabling control of memory usage and
+	 * approximation error.
 	 * <p>
 	 * API name: {@code compression}
 	 */
@@ -105,9 +105,9 @@ public static class Builder extends MetricAggregationBase.AbstractBuilder<Builde
 		private Double compression;
 
 		/**
-		 * Controls memory usage and approximation error by limiting the maximum number
-		 * of nodes used by the underlying TDigest algorithm to
-		 * <code>20 * compression</code>.
+		 * Limits the maximum number of nodes used by the underlying TDigest algorithm
+		 * to <code>20 * compression</code>, enabling control of memory usage and
+		 * approximation error.
 		 * <p>
 		 * API name: {@code compression}
 		 */

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/CardinalityExecutionMode.java

@@ -36,19 +36,19 @@
 @JsonpDeserializable
 public enum CardinalityExecutionMode implements JsonEnum {
 	/**
-	 * Run aggregation by using global ordinals of the field and resolving those
+	 * Run the aggregation by using global ordinals of the field and resolving those
 	 * values after finishing a shard.
 	 */
 	GlobalOrdinals("global_ordinals"),
 
 	/**
-	 * Run aggregation by using segment ordinal values and resolving those values
-	 * after each segment.
+	 * Run the aggregation by using segment ordinal values and resolving those
+	 * values after each segment.
 	 */
 	SegmentOrdinals("segment_ordinals"),
 
 	/**
-	 * Run aggregation by using field values directly.
+	 * Run the aggregation by using field values directly.
 	 */
 	Direct("direct"),
 

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/CategorizeTextAggregation.java

@@ -214,7 +214,7 @@ public final Integer size() {
 	}
 
 	/**
-	 * The minimum number of documents for a bucket to be returned to the results.
+	 * The minimum number of documents in a bucket to be returned to the results.
 	 * <p>
 	 * API name: {@code min_doc_count}
 	 */
@@ -224,7 +224,7 @@ public final Integer minDocCount() {
 	}
 
 	/**
-	 * The minimum number of documents for a bucket to be returned from the shard
+	 * The minimum number of documents in a bucket to be returned from the shard
 	 * before merging.
 	 * <p>
 	 * API name: {@code shard_min_doc_count}
@@ -475,7 +475,7 @@ public final Builder size(@Nullable Integer value) {
 		}
 
 		/**
-		 * The minimum number of documents for a bucket to be returned to the results.
+		 * The minimum number of documents in a bucket to be returned to the results.
 		 * <p>
 		 * API name: {@code min_doc_count}
 		 */
@@ -485,7 +485,7 @@ public final Builder minDocCount(@Nullable Integer value) {
 		}
 
 		/**
-		 * The minimum number of documents for a bucket to be returned from the shard
+		 * The minimum number of documents in a bucket to be returned from the shard
 		 * before merging.
 		 * <p>
 		 * API name: {@code shard_min_doc_count}

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/ChiSquareHeuristic.java

@@ -67,14 +67,21 @@ public static ChiSquareHeuristic of(Function<Builder, ObjectBuilder<ChiSquareHeu
 	}
 
 	/**
-	 * Required - API name: {@code background_is_superset}
+	 * Required - Set to <code>false</code> if you defined a custom background
+	 * filter that represents a different set of documents that you want to compare
+	 * to.
+	 * <p>
+	 * API name: {@code background_is_superset}
 	 */
 	public final boolean backgroundIsSuperset() {
 		return this.backgroundIsSuperset;
 	}
 
 	/**
-	 * Required - API name: {@code include_negatives}
+	 * Required - Set to <code>false</code> to filter out the terms that appear less
+	 * often in the subset than in documents outside the subset.
+	 * <p>
+	 * API name: {@code include_negatives}
 	 */
 	public final boolean includeNegatives() {
 		return this.includeNegatives;
@@ -118,15 +125,22 @@ public static class Builder extends WithJsonObjectBuilderBase<Builder>
 		private Boolean includeNegatives;
 
 		/**
-		 * Required - API name: {@code background_is_superset}
+		 * Required - Set to <code>false</code> if you defined a custom background
+		 * filter that represents a different set of documents that you want to compare
+		 * to.
+		 * <p>
+		 * API name: {@code background_is_superset}
 		 */
 		public final Builder backgroundIsSuperset(boolean value) {
 			this.backgroundIsSuperset = value;
 			return this;
 		}
 
 		/**
-		 * Required - API name: {@code include_negatives}
+		 * Required - Set to <code>false</code> to filter out the terms that appear less
+		 * often in the subset than in documents outside the subset.
+		 * <p>
+		 * API name: {@code include_negatives}
 		 */
 		public final Builder includeNegatives(boolean value) {
 			this.includeNegatives = value;

java-client/src/main/java/co/elastic/clients/elasticsearch/_types/aggregations/DateHistogramAggregation.java

@@ -255,7 +255,7 @@ public final Time offset() {
 	}
 
 	/**
-	 * The order of the returned buckets.
+	 * The sort order of the returned buckets.
 	 * <p>
 	 * API name: {@code order}
 	 */
@@ -291,7 +291,7 @@ public final String timeZone() {
 
 	/**
 	 * Set to <code>true</code> to associate a unique string key with each bucket
-	 * and returns the ranges as a hash rather than an array.
+	 * and return the ranges as a hash rather than an array.
 	 * <p>
 	 * API name: {@code keyed}
 	 */
@@ -609,7 +609,7 @@ public final Builder offset(Function<Time.Builder, ObjectBuilder<Time>> fn) {
 		}
 
 		/**
-		 * The order of the returned buckets.
+		 * The sort order of the returned buckets.
 		 * <p>
 		 * API name: {@code order}
 		 * <p>
@@ -621,7 +621,7 @@ public final Builder order(List<NamedValue<SortOrder>> list) {
 		}
 
 		/**
-		 * The order of the returned buckets.
+		 * The sort order of the returned buckets.
 		 * <p>
 		 * API name: {@code order}
 		 * <p>
@@ -680,7 +680,7 @@ public final Builder timeZone(@Nullable String value) {
 
 		/**
 		 * Set to <code>true</code> to associate a unique string key with each bucket
-		 * and returns the ranges as a hash rather than an array.
+		 * and return the ranges as a hash rather than an array.
 		 * <p>
 		 * API name: {@code keyed}
 		 */