Skip to content

Improve generated XmlDoc #8292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,11 @@ public sealed partial class AsyncSearchStatusRequestParameters : RequestParamete
}

/// <summary>
/// <para>Get async search status<br/>Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.<br/>If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.</para>
/// <para>
/// Get async search status
/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
/// If the Elasticsearch security features are enabled, use of this API is restricted to the <c>monitoring_user</c> role.
/// </para>
/// </summary>
public sealed partial class AsyncSearchStatusRequest : PlainRequest<AsyncSearchStatusRequestParameters>
{
Expand All @@ -52,7 +56,11 @@ public AsyncSearchStatusRequest(Elastic.Clients.Elasticsearch.Serverless.Id id)
}

/// <summary>
/// <para>Get async search status<br/>Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.<br/>If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.</para>
/// <para>
/// Get async search status
/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
/// If the Elasticsearch security features are enabled, use of this API is restricted to the <c>monitoring_user</c> role.
/// </para>
/// </summary>
public sealed partial class AsyncSearchStatusRequestDescriptor<TDocument> : RequestDescriptor<AsyncSearchStatusRequestDescriptor<TDocument>, AsyncSearchStatusRequestParameters>
{
Expand Down Expand Up @@ -82,7 +90,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
}

/// <summary>
/// <para>Get async search status<br/>Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.<br/>If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.</para>
/// <para>
/// Get async search status
/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
/// If the Elasticsearch security features are enabled, use of this API is restricted to the <c>monitoring_user</c> role.
/// </para>
/// </summary>
public sealed partial class AsyncSearchStatusRequestDescriptor : RequestDescriptor<AsyncSearchStatusRequestDescriptor, AsyncSearchStatusRequestParameters>
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,27 +29,39 @@ namespace Elastic.Clients.Elasticsearch.Serverless.AsyncSearch;
public sealed partial class AsyncSearchStatusResponse : ElasticsearchResponse
{
/// <summary>
/// <para>Metadata about clusters involved in the cross-cluster search.<br/>Not shown for local-only searches.</para>
/// <para>
/// Metadata about clusters involved in the cross-cluster search.
/// Not shown for local-only searches.
/// </para>
/// </summary>
[JsonInclude, JsonPropertyName("_clusters")]
public Elastic.Clients.Elasticsearch.Serverless.ClusterStatistics? Clusters { get; init; }

/// <summary>
/// <para>If the async search completed, this field shows the status code of the search.<br/>For example, 200 indicates that the async search was successfully completed.<br/>503 indicates that the async search was completed with an error.</para>
/// <para>
/// If the async search completed, this field shows the status code of the search.
/// For example, 200 indicates that the async search was successfully completed.
/// 503 indicates that the async search was completed with an error.
/// </para>
/// </summary>
[JsonInclude, JsonPropertyName("completion_status")]
public int? CompletionStatus { get; init; }

/// <summary>
/// <para>Indicates when the async search completed. Only present<br/>when the search has completed.</para>
/// <para>
/// Indicates when the async search completed. Only present
/// when the search has completed.
/// </para>
/// </summary>
[JsonInclude, JsonPropertyName("completion_time")]
public DateTimeOffset? CompletionTime { get; init; }
[JsonInclude, JsonPropertyName("completion_time_in_millis")]
public long? CompletionTimeInMillis { get; init; }

/// <summary>
/// <para>Indicates when the async search will expire.</para>
/// <para>
/// Indicates when the async search will expire.
/// </para>
/// </summary>
[JsonInclude, JsonPropertyName("expiration_time")]
public DateTimeOffset? ExpirationTime { get; init; }
Expand All @@ -59,19 +71,27 @@ public sealed partial class AsyncSearchStatusResponse : ElasticsearchResponse
public string? Id { get; init; }

/// <summary>
/// <para>When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.<br/>While the query is running, `is_partial` is always set to `true`.</para>
/// <para>
/// When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.
/// While the query is running, <c>is_partial</c> is always set to <c>true</c>.
/// </para>
/// </summary>
[JsonInclude, JsonPropertyName("is_partial")]
public bool IsPartial { get; init; }

/// <summary>
/// <para>Indicates whether the search is still running or has completed.<br/>NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`.</para>
/// <para>
/// Indicates whether the search is still running or has completed.
/// NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though <c>is_running</c> is <c>false</c>.
/// </para>
/// </summary>
[JsonInclude, JsonPropertyName("is_running")]
public bool IsRunning { get; init; }

/// <summary>
/// <para>Indicates how many shards have run the query so far.</para>
/// <para>
/// Indicates how many shards have run the query so far.
/// </para>
/// </summary>
[JsonInclude, JsonPropertyName("_shards")]
public Elastic.Clients.Elasticsearch.Serverless.ShardStatistics Shards { get; init; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,12 @@ public sealed partial class DeleteAsyncSearchRequestParameters : RequestParamete
}

/// <summary>
/// <para>Deletes an async search by identifier.<br/>If the search is still running, the search request will be cancelled.<br/>Otherwise, the saved search results are deleted.<br/>If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.</para>
/// <para>
/// Deletes an async search by identifier.
/// If the search is still running, the search request will be cancelled.
/// Otherwise, the saved search results are deleted.
/// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the <c>cancel_task</c> cluster privilege.
/// </para>
/// </summary>
public sealed partial class DeleteAsyncSearchRequest : PlainRequest<DeleteAsyncSearchRequestParameters>
{
Expand All @@ -52,7 +57,12 @@ public DeleteAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Id id)
}

/// <summary>
/// <para>Deletes an async search by identifier.<br/>If the search is still running, the search request will be cancelled.<br/>Otherwise, the saved search results are deleted.<br/>If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.</para>
/// <para>
/// Deletes an async search by identifier.
/// If the search is still running, the search request will be cancelled.
/// Otherwise, the saved search results are deleted.
/// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the <c>cancel_task</c> cluster privilege.
/// </para>
/// </summary>
public sealed partial class DeleteAsyncSearchRequestDescriptor<TDocument> : RequestDescriptor<DeleteAsyncSearchRequestDescriptor<TDocument>, DeleteAsyncSearchRequestParameters>
{
Expand Down Expand Up @@ -82,7 +92,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
}

/// <summary>
/// <para>Deletes an async search by identifier.<br/>If the search is still running, the search request will be cancelled.<br/>Otherwise, the saved search results are deleted.<br/>If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.</para>
/// <para>
/// Deletes an async search by identifier.
/// If the search is still running, the search request will be cancelled.
/// Otherwise, the saved search results are deleted.
/// If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the <c>cancel_task</c> cluster privilege.
/// </para>
/// </summary>
public sealed partial class DeleteAsyncSearchRequestDescriptor : RequestDescriptor<DeleteAsyncSearchRequestDescriptor, DeleteAsyncSearchRequestParameters>
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.AsyncSearch;
public sealed partial class DeleteAsyncSearchResponse : ElasticsearchResponse
{
/// <summary>
/// <para>For a successful response, this value is always true. On failure, an exception is returned instead.</para>
/// <para>
/// For a successful response, this value is always true. On failure, an exception is returned instead.
/// </para>
/// </summary>
[JsonInclude, JsonPropertyName("acknowledged")]
public bool Acknowledged { get; init; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,23 +32,38 @@ namespace Elastic.Clients.Elasticsearch.Serverless.AsyncSearch;
public sealed partial class GetAsyncSearchRequestParameters : RequestParameters
{
/// <summary>
/// <para>Specifies how long the async search should be available in the cluster.<br/>When not specified, the `keep_alive` set with the corresponding submit async request will be used.<br/>Otherwise, it is possible to override the value and extend the validity of the request.<br/>When this period expires, the search, if still running, is cancelled.<br/>If the search is completed, its saved results are deleted.</para>
/// <para>
/// Specifies how long the async search should be available in the cluster.
/// When not specified, the <c>keep_alive</c> set with the corresponding submit async request will be used.
/// Otherwise, it is possible to override the value and extend the validity of the request.
/// When this period expires, the search, if still running, is cancelled.
/// If the search is completed, its saved results are deleted.
/// </para>
/// </summary>
public Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAlive { get => Q<Elastic.Clients.Elasticsearch.Serverless.Duration?>("keep_alive"); set => Q("keep_alive", value); }

/// <summary>
/// <para>Specify whether aggregation and suggester names should be prefixed by their respective types in the response</para>
/// <para>
/// Specify whether aggregation and suggester names should be prefixed by their respective types in the response
/// </para>
/// </summary>
public bool? TypedKeys { get => Q<bool?>("typed_keys"); set => Q("typed_keys", value); }

/// <summary>
/// <para>Specifies to wait for the search to be completed up until the provided timeout.<br/>Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.<br/>By default no timeout is set meaning that the currently available results will be returned without any additional wait.</para>
/// <para>
/// Specifies to wait for the search to be completed up until the provided timeout.
/// Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.
/// By default no timeout is set meaning that the currently available results will be returned without any additional wait.
/// </para>
/// </summary>
public Elastic.Clients.Elasticsearch.Serverless.Duration? WaitForCompletionTimeout { get => Q<Elastic.Clients.Elasticsearch.Serverless.Duration?>("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); }
}

/// <summary>
/// <para>Retrieves the results of a previously submitted async search request given its identifier.<br/>If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.</para>
/// <para>
/// Retrieves the results of a previously submitted async search request given its identifier.
/// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.
/// </para>
/// </summary>
public sealed partial class GetAsyncSearchRequest : PlainRequest<GetAsyncSearchRequestParameters>
{
Expand All @@ -65,26 +80,41 @@ public GetAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : b
internal override string OperationName => "async_search.get";

/// <summary>
/// <para>Specifies how long the async search should be available in the cluster.<br/>When not specified, the `keep_alive` set with the corresponding submit async request will be used.<br/>Otherwise, it is possible to override the value and extend the validity of the request.<br/>When this period expires, the search, if still running, is cancelled.<br/>If the search is completed, its saved results are deleted.</para>
/// <para>
/// Specifies how long the async search should be available in the cluster.
/// When not specified, the <c>keep_alive</c> set with the corresponding submit async request will be used.
/// Otherwise, it is possible to override the value and extend the validity of the request.
/// When this period expires, the search, if still running, is cancelled.
/// If the search is completed, its saved results are deleted.
/// </para>
/// </summary>
[JsonIgnore]
public Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAlive { get => Q<Elastic.Clients.Elasticsearch.Serverless.Duration?>("keep_alive"); set => Q("keep_alive", value); }

/// <summary>
/// <para>Specify whether aggregation and suggester names should be prefixed by their respective types in the response</para>
/// <para>
/// Specify whether aggregation and suggester names should be prefixed by their respective types in the response
/// </para>
/// </summary>
[JsonIgnore]
public bool? TypedKeys { get => Q<bool?>("typed_keys"); set => Q("typed_keys", value); }

/// <summary>
/// <para>Specifies to wait for the search to be completed up until the provided timeout.<br/>Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.<br/>By default no timeout is set meaning that the currently available results will be returned without any additional wait.</para>
/// <para>
/// Specifies to wait for the search to be completed up until the provided timeout.
/// Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.
/// By default no timeout is set meaning that the currently available results will be returned without any additional wait.
/// </para>
/// </summary>
[JsonIgnore]
public Elastic.Clients.Elasticsearch.Serverless.Duration? WaitForCompletionTimeout { get => Q<Elastic.Clients.Elasticsearch.Serverless.Duration?>("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); }
}

/// <summary>
/// <para>Retrieves the results of a previously submitted async search request given its identifier.<br/>If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.</para>
/// <para>
/// Retrieves the results of a previously submitted async search request given its identifier.
/// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.
/// </para>
/// </summary>
public sealed partial class GetAsyncSearchRequestDescriptor<TDocument> : RequestDescriptor<GetAsyncSearchRequestDescriptor<TDocument>, GetAsyncSearchRequestParameters>
{
Expand Down Expand Up @@ -118,7 +148,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
}

/// <summary>
/// <para>Retrieves the results of a previously submitted async search request given its identifier.<br/>If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.</para>
/// <para>
/// Retrieves the results of a previously submitted async search request given its identifier.
/// If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.
/// </para>
/// </summary>
public sealed partial class GetAsyncSearchRequestDescriptor : RequestDescriptor<GetAsyncSearchRequestDescriptor, GetAsyncSearchRequestParameters>
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,20 @@ namespace Elastic.Clients.Elasticsearch.Serverless.AsyncSearch;
public sealed partial class GetAsyncSearchResponse<TDocument> : ElasticsearchResponse
{
/// <summary>
/// <para>Indicates when the async search completed. Only present<br/>when the search has completed.</para>
/// <para>
/// Indicates when the async search completed. Only present
/// when the search has completed.
/// </para>
/// </summary>
[JsonInclude, JsonPropertyName("completion_time")]
public DateTimeOffset? CompletionTime { get; init; }
[JsonInclude, JsonPropertyName("completion_time_in_millis")]
public long? CompletionTimeInMillis { get; init; }

/// <summary>
/// <para>Indicates when the async search will expire.</para>
/// <para>
/// Indicates when the async search will expire.
/// </para>
/// </summary>
[JsonInclude, JsonPropertyName("expiration_time")]
public DateTimeOffset? ExpirationTime { get; init; }
Expand All @@ -47,13 +52,19 @@ public sealed partial class GetAsyncSearchResponse<TDocument> : ElasticsearchRes
public string? Id { get; init; }

/// <summary>
/// <para>When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.<br/>While the query is running, `is_partial` is always set to `true`.</para>
/// <para>
/// When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.
/// While the query is running, <c>is_partial</c> is always set to <c>true</c>.
/// </para>
/// </summary>
[JsonInclude, JsonPropertyName("is_partial")]
public bool IsPartial { get; init; }

/// <summary>
/// <para>Indicates whether the search is still running or has completed.<br/>NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`.</para>
/// <para>
/// Indicates whether the search is still running or has completed.
/// NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though <c>is_running</c> is <c>false</c>.
/// </para>
/// </summary>
[JsonInclude, JsonPropertyName("is_running")]
public bool IsRunning { get; init; }
Expand Down
Loading
Loading