diff --git a/java-client/src/generated/java/org/opensearch/client/opensearch/_types/AcknowledgedResponseBase.java b/java-client/src/generated/java/org/opensearch/client/opensearch/_types/AcknowledgedResponseBase.java index ca1bf3300b..c7ab7d8510 100644 --- a/java-client/src/generated/java/org/opensearch/client/opensearch/_types/AcknowledgedResponseBase.java +++ b/java-client/src/generated/java/org/opensearch/client/opensearch/_types/AcknowledgedResponseBase.java @@ -59,8 +59,10 @@ protected AcknowledgedResponseBase(AbstractBuilder builder) { } /** - * Required - For a successful response, this value is always true. On failure, an exception is returned instead.
+ * Required - For a successful response, this value is always true. On failure, an exception is returned instead. + *

* API name: {@code acknowledged} + *

*/ public final boolean acknowledged() { return this.acknowledged; @@ -88,8 +90,10 @@ protected abstract static class AbstractBuilder + * Required - For a successful response, this value is always true. On failure, an exception is returned instead. + *

* API name: {@code acknowledged} + *

*/ public final BuilderT acknowledged(boolean value) { this.acknowledged = value; diff --git a/java-client/src/generated/java/org/opensearch/client/opensearch/_types/ErrorCause.java b/java-client/src/generated/java/org/opensearch/client/opensearch/_types/ErrorCause.java index 106dcbe2bd..2941b7ea30 100644 --- a/java-client/src/generated/java/org/opensearch/client/opensearch/_types/ErrorCause.java +++ b/java-client/src/generated/java/org/opensearch/client/opensearch/_types/ErrorCause.java @@ -102,8 +102,10 @@ public final ErrorCause causedBy() { } /** - * A human-readable explanation of the error, in english
+ * A human-readable explanation of the error, in english + *

* API name: {@code reason} + *

*/ @Nullable public final String reason() { @@ -118,8 +120,10 @@ public final List rootCause() { } /** - * The server stack trace. Present only if the `error_trace=true` parameter was sent with the request.
+ * The server stack trace. Present only if the `error_trace=true` parameter was sent with the request. + *

* API name: {@code stack_trace} + *

*/ @Nullable public final String stackTrace() { @@ -134,8 +138,10 @@ public final List suppressed() { } /** - * Required - The type of error
+ * Required - The type of error + *

* API name: {@code type} + *

*/ public final String type() { return this.type; @@ -246,8 +252,10 @@ public final Builder causedBy(Function + * A human-readable explanation of the error, in english + *

* API name: {@code reason} + *

*/ public final Builder reason(@Nullable String value) { this.reason = value; @@ -290,8 +298,10 @@ public final Builder rootCause(Function + * The server stack trace. Present only if the `error_trace=true` parameter was sent with the request. + *

* API name: {@code stack_trace} + *

*/ public final Builder stackTrace(@Nullable String value) { this.stackTrace = value; @@ -334,8 +344,10 @@ public final Builder suppressed(Function + * Required - The type of error + *

* API name: {@code type} + *

*/ public final Builder type(String value) { this.type = value; diff --git a/java-client/src/generated/java/org/opensearch/client/opensearch/_types/NodeStatistics.java b/java-client/src/generated/java/org/opensearch/client/opensearch/_types/NodeStatistics.java index 78dcc0c763..12b40c0fe4 100644 --- a/java-client/src/generated/java/org/opensearch/client/opensearch/_types/NodeStatistics.java +++ b/java-client/src/generated/java/org/opensearch/client/opensearch/_types/NodeStatistics.java @@ -80,8 +80,10 @@ public static NodeStatistics of(Function + * failure is included in the response. + *

* API name: {@code failed} + *

*/ public final int failed() { return this.failed; @@ -95,16 +97,20 @@ public final List failures() { } /** - * Required - Number of nodes that responded successfully to the request.
+ * Required - Number of nodes that responded successfully to the request. + *

* API name: {@code successful} + *

*/ public final int successful() { return this.successful; } /** - * Required - Total number of nodes selected by the request.
+ * Required - Total number of nodes selected by the request. + *

* API name: {@code total} + *

*/ public final int total() { return this.total; @@ -157,8 +163,10 @@ public static class Builder extends ObjectBuilderBase implements ObjectBuilder + * failure is included in the response. + *

* API name: {@code failed} + *

*/ public final Builder failed(int value) { this.failed = value; @@ -201,8 +209,10 @@ public final Builder failures(Function + * Required - Number of nodes that responded successfully to the request. + *

* API name: {@code successful} + *

*/ public final Builder successful(int value) { this.successful = value; @@ -210,8 +220,10 @@ public final Builder successful(int value) { } /** - * Required - Total number of nodes selected by the request.
+ * Required - Total number of nodes selected by the request. + *

* API name: {@code total} + *

*/ public final Builder total(int value) { this.total = value; diff --git a/java-client/src/generated/java/org/opensearch/client/opensearch/dangling_indices/DeleteDanglingIndexRequest.java b/java-client/src/generated/java/org/opensearch/client/opensearch/dangling_indices/DeleteDanglingIndexRequest.java index 0e9799af77..4f6ea2ac3c 100644 --- a/java-client/src/generated/java/org/opensearch/client/opensearch/dangling_indices/DeleteDanglingIndexRequest.java +++ b/java-client/src/generated/java/org/opensearch/client/opensearch/dangling_indices/DeleteDanglingIndexRequest.java @@ -89,16 +89,20 @@ public static DeleteDanglingIndexRequest of( } /** - * Required - Must be set to true in order to delete the dangling index
+ * Required - Must be set to true in order to delete the dangling index + *

* API name: {@code accept_data_loss} + *

*/ public final boolean acceptDataLoss() { return this.acceptDataLoss; } /** - * Operation timeout for connection to cluster-manager node.
+ * Operation timeout for connection to cluster-manager node. + *

* API name: {@code cluster_manager_timeout} + *

*/ @Nullable public final Time clusterManagerTimeout() { @@ -106,16 +110,20 @@ public final Time clusterManagerTimeout() { } /** - * Required - The UUID of the dangling index
+ * Required - The UUID of the dangling index + *

* API name: {@code index_uuid} + *

*/ public final String indexUuid() { return this.indexUuid; } /** - * Specify timeout for connection to master
+ * Specify timeout for connection to master + *

* API name: {@code master_timeout} + *

*/ @Deprecated @Nullable @@ -124,8 +132,10 @@ public final Time masterTimeout() { } /** - * Explicit operation timeout
+ * Explicit operation timeout + *

* API name: {@code timeout} + *

*/ @Nullable public final Time timeout() { @@ -148,8 +158,10 @@ public static class Builder extends ObjectBuilderBase implements ObjectBuilder + * Required - Must be set to true in order to delete the dangling index + *

* API name: {@code accept_data_loss} + *

*/ public final Builder acceptDataLoss(boolean value) { this.acceptDataLoss = value; @@ -157,8 +169,10 @@ public final Builder acceptDataLoss(boolean value) { } /** - * Operation timeout for connection to cluster-manager node.
+ * Operation timeout for connection to cluster-manager node. + *

* API name: {@code cluster_manager_timeout} + *

*/ public final Builder clusterManagerTimeout(@Nullable Time value) { this.clusterManagerTimeout = value; @@ -166,16 +180,20 @@ public final Builder clusterManagerTimeout(@Nullable Time value) { } /** - * Operation timeout for connection to cluster-manager node.
+ * Operation timeout for connection to cluster-manager node. + *

* API name: {@code cluster_manager_timeout} + *

*/ public final Builder clusterManagerTimeout(Function> fn) { return clusterManagerTimeout(fn.apply(new Time.Builder()).build()); } /** - * Required - The UUID of the dangling index
+ * Required - The UUID of the dangling index + *

* API name: {@code index_uuid} + *

*/ public final Builder indexUuid(String value) { this.indexUuid = value; @@ -183,8 +201,10 @@ public final Builder indexUuid(String value) { } /** - * Specify timeout for connection to master
+ * Specify timeout for connection to master + *

* API name: {@code master_timeout} + *

*/ @Deprecated public final Builder masterTimeout(@Nullable Time value) { @@ -193,8 +213,10 @@ public final Builder masterTimeout(@Nullable Time value) { } /** - * Specify timeout for connection to master
+ * Specify timeout for connection to master + *

* API name: {@code master_timeout} + *

*/ @Deprecated public final Builder masterTimeout(Function> fn) { @@ -202,8 +224,10 @@ public final Builder masterTimeout(Function> f } /** - * Explicit operation timeout
+ * Explicit operation timeout + *

* API name: {@code timeout} + *

*/ public final Builder timeout(@Nullable Time value) { this.timeout = value; @@ -211,8 +235,10 @@ public final Builder timeout(@Nullable Time value) { } /** - * Explicit operation timeout
+ * Explicit operation timeout + *

* API name: {@code timeout} + *

*/ public final Builder timeout(Function> fn) { return timeout(fn.apply(new Time.Builder()).build()); diff --git a/java-client/src/generated/java/org/opensearch/client/opensearch/dangling_indices/ImportDanglingIndexRequest.java b/java-client/src/generated/java/org/opensearch/client/opensearch/dangling_indices/ImportDanglingIndexRequest.java index c54783767d..4b1440b7eb 100644 --- a/java-client/src/generated/java/org/opensearch/client/opensearch/dangling_indices/ImportDanglingIndexRequest.java +++ b/java-client/src/generated/java/org/opensearch/client/opensearch/dangling_indices/ImportDanglingIndexRequest.java @@ -89,16 +89,20 @@ public static ImportDanglingIndexRequest of( } /** - * Required - Must be set to true in order to import the dangling index
+ * Required - Must be set to true in order to import the dangling index + *

* API name: {@code accept_data_loss} + *

*/ public final boolean acceptDataLoss() { return this.acceptDataLoss; } /** - * Operation timeout for connection to cluster-manager node.
+ * Operation timeout for connection to cluster-manager node. + *

* API name: {@code cluster_manager_timeout} + *

*/ @Nullable public final Time clusterManagerTimeout() { @@ -106,16 +110,20 @@ public final Time clusterManagerTimeout() { } /** - * Required - The UUID of the dangling index
+ * Required - The UUID of the dangling index + *

* API name: {@code index_uuid} + *

*/ public final String indexUuid() { return this.indexUuid; } /** - * Specify timeout for connection to master
+ * Specify timeout for connection to master + *

* API name: {@code master_timeout} + *

*/ @Deprecated @Nullable @@ -124,8 +132,10 @@ public final Time masterTimeout() { } /** - * Explicit operation timeout
+ * Explicit operation timeout + *

* API name: {@code timeout} + *

*/ @Nullable public final Time timeout() { @@ -148,8 +158,10 @@ public static class Builder extends ObjectBuilderBase implements ObjectBuilder + * Required - Must be set to true in order to import the dangling index + *

* API name: {@code accept_data_loss} + *

*/ public final Builder acceptDataLoss(boolean value) { this.acceptDataLoss = value; @@ -157,8 +169,10 @@ public final Builder acceptDataLoss(boolean value) { } /** - * Operation timeout for connection to cluster-manager node.
+ * Operation timeout for connection to cluster-manager node. + *

* API name: {@code cluster_manager_timeout} + *

*/ public final Builder clusterManagerTimeout(@Nullable Time value) { this.clusterManagerTimeout = value; @@ -166,16 +180,20 @@ public final Builder clusterManagerTimeout(@Nullable Time value) { } /** - * Operation timeout for connection to cluster-manager node.
+ * Operation timeout for connection to cluster-manager node. + *

* API name: {@code cluster_manager_timeout} + *

*/ public final Builder clusterManagerTimeout(Function> fn) { return clusterManagerTimeout(fn.apply(new Time.Builder()).build()); } /** - * Required - The UUID of the dangling index
+ * Required - The UUID of the dangling index + *

* API name: {@code index_uuid} + *

*/ public final Builder indexUuid(String value) { this.indexUuid = value; @@ -183,8 +201,10 @@ public final Builder indexUuid(String value) { } /** - * Specify timeout for connection to master
+ * Specify timeout for connection to master + *

* API name: {@code master_timeout} + *

*/ @Deprecated public final Builder masterTimeout(@Nullable Time value) { @@ -193,8 +213,10 @@ public final Builder masterTimeout(@Nullable Time value) { } /** - * Specify timeout for connection to master
+ * Specify timeout for connection to master + *

* API name: {@code master_timeout} + *

*/ @Deprecated public final Builder masterTimeout(Function> fn) { @@ -202,8 +224,10 @@ public final Builder masterTimeout(Function> f } /** - * Explicit operation timeout
+ * Explicit operation timeout + *

* API name: {@code timeout} + *

*/ public final Builder timeout(@Nullable Time value) { this.timeout = value; @@ -211,8 +235,10 @@ public final Builder timeout(@Nullable Time value) { } /** - * Explicit operation timeout
+ * Explicit operation timeout + *

* API name: {@code timeout} + *

*/ public final Builder timeout(Function> fn) { return timeout(fn.apply(new Time.Builder()).build()); diff --git a/java-codegen/src/main/resources/org/opensearch/client/codegen/templates/ObjectShape/FieldDoc/BasicInner.mustache b/java-codegen/src/main/resources/org/opensearch/client/codegen/templates/ObjectShape/FieldDoc/BasicInner.mustache index bace7cc682..851ccc468e 100644 --- a/java-codegen/src/main/resources/org/opensearch/client/codegen/templates/ObjectShape/FieldDoc/BasicInner.mustache +++ b/java-codegen/src/main/resources/org/opensearch/client/codegen/templates/ObjectShape/FieldDoc/BasicInner.mustache @@ -1,5 +1,5 @@ {{^isAdditionalProperties}} -* {{#required}}Required - {{/required}}{{#description}}{{.}}
{{/description}}API name: {@code {{wireName}}} +* {{#required}}Required - {{/required}}{{#description}}{{.}}

{{/description}}API name: {@code {{wireName}}}{{#description}}

{{/description}} {{/isAdditionalProperties}} {{#isAdditionalProperties}} * {{description}}