Skip to content

Commit b64c69b

Browse files
floberndgithub-actions[bot]
flobernd
authored and
github-actions[bot]
committed
Improve generated XmlDoc (#8292)
1 parent fc3086b commit b64c69b

File tree

2,205 files changed

+101926
-27237
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,205 files changed

+101926
-27237
lines changed

Diff for: ‎src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs

+15-3
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,11 @@ public sealed partial class AsyncSearchStatusRequestParameters : RequestParamete
3434
}
3535

3636
/// <summary>
37-
/// <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>
37+
/// <para>
38+
/// Get async search status
39+
/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
40+
/// If the Elasticsearch security features are enabled, use of this API is restricted to the <c>monitoring_user</c> role.
41+
/// </para>
3842
/// </summary>
3943
public sealed partial class AsyncSearchStatusRequest : PlainRequest<AsyncSearchStatusRequestParameters>
4044
{
@@ -52,7 +56,11 @@ public AsyncSearchStatusRequest(Elastic.Clients.Elasticsearch.Serverless.Id id)
5256
}
5357

5458
/// <summary>
55-
/// <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>
59+
/// <para>
60+
/// Get async search status
61+
/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
62+
/// If the Elasticsearch security features are enabled, use of this API is restricted to the <c>monitoring_user</c> role.
63+
/// </para>
5664
/// </summary>
5765
public sealed partial class AsyncSearchStatusRequestDescriptor<TDocument> : RequestDescriptor<AsyncSearchStatusRequestDescriptor<TDocument>, AsyncSearchStatusRequestParameters>
5866
{
@@ -82,7 +90,11 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
8290
}
8391

8492
/// <summary>
85-
/// <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>
93+
/// <para>
94+
/// Get async search status
95+
/// Retrieves the status of a previously submitted async search request given its identifier, without retrieving search results.
96+
/// If the Elasticsearch security features are enabled, use of this API is restricted to the <c>monitoring_user</c> role.
97+
/// </para>
8698
/// </summary>
8799
public sealed partial class AsyncSearchStatusRequestDescriptor : RequestDescriptor<AsyncSearchStatusRequestDescriptor, AsyncSearchStatusRequestParameters>
88100
{

Diff for: ‎src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/AsyncSearchStatusResponse.g.cs

+27-7
Original file line numberDiff line numberDiff line change
@@ -29,27 +29,39 @@ namespace Elastic.Clients.Elasticsearch.Serverless.AsyncSearch;
2929
public sealed partial class AsyncSearchStatusResponse : ElasticsearchResponse
3030
{
3131
/// <summary>
32-
/// <para>Metadata about clusters involved in the cross-cluster search.<br/>Not shown for local-only searches.</para>
32+
/// <para>
33+
/// Metadata about clusters involved in the cross-cluster search.
34+
/// Not shown for local-only searches.
35+
/// </para>
3336
/// </summary>
3437
[JsonInclude, JsonPropertyName("_clusters")]
3538
public Elastic.Clients.Elasticsearch.Serverless.ClusterStatistics? Clusters { get; init; }
3639

3740
/// <summary>
38-
/// <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>
41+
/// <para>
42+
/// If the async search completed, this field shows the status code of the search.
43+
/// For example, 200 indicates that the async search was successfully completed.
44+
/// 503 indicates that the async search was completed with an error.
45+
/// </para>
3946
/// </summary>
4047
[JsonInclude, JsonPropertyName("completion_status")]
4148
public int? CompletionStatus { get; init; }
4249

4350
/// <summary>
44-
/// <para>Indicates when the async search completed. Only present<br/>when the search has completed.</para>
51+
/// <para>
52+
/// Indicates when the async search completed. Only present
53+
/// when the search has completed.
54+
/// </para>
4555
/// </summary>
4656
[JsonInclude, JsonPropertyName("completion_time")]
4757
public DateTimeOffset? CompletionTime { get; init; }
4858
[JsonInclude, JsonPropertyName("completion_time_in_millis")]
4959
public long? CompletionTimeInMillis { get; init; }
5060

5161
/// <summary>
52-
/// <para>Indicates when the async search will expire.</para>
62+
/// <para>
63+
/// Indicates when the async search will expire.
64+
/// </para>
5365
/// </summary>
5466
[JsonInclude, JsonPropertyName("expiration_time")]
5567
public DateTimeOffset? ExpirationTime { get; init; }
@@ -59,19 +71,27 @@ public sealed partial class AsyncSearchStatusResponse : ElasticsearchResponse
5971
public string? Id { get; init; }
6072

6173
/// <summary>
62-
/// <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>
74+
/// <para>
75+
/// When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.
76+
/// While the query is running, <c>is_partial</c> is always set to <c>true</c>.
77+
/// </para>
6378
/// </summary>
6479
[JsonInclude, JsonPropertyName("is_partial")]
6580
public bool IsPartial { get; init; }
6681

6782
/// <summary>
68-
/// <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>
83+
/// <para>
84+
/// Indicates whether the search is still running or has completed.
85+
/// 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>.
86+
/// </para>
6987
/// </summary>
7088
[JsonInclude, JsonPropertyName("is_running")]
7189
public bool IsRunning { get; init; }
7290

7391
/// <summary>
74-
/// <para>Indicates how many shards have run the query so far.</para>
92+
/// <para>
93+
/// Indicates how many shards have run the query so far.
94+
/// </para>
7595
/// </summary>
7696
[JsonInclude, JsonPropertyName("_shards")]
7797
public Elastic.Clients.Elasticsearch.Serverless.ShardStatistics Shards { get; init; }

Diff for: ‎src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs

+18-3
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,12 @@ public sealed partial class DeleteAsyncSearchRequestParameters : RequestParamete
3434
}
3535

3636
/// <summary>
37-
/// <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>
37+
/// <para>
38+
/// Deletes an async search by identifier.
39+
/// If the search is still running, the search request will be cancelled.
40+
/// Otherwise, the saved search results are deleted.
41+
/// 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.
42+
/// </para>
3843
/// </summary>
3944
public sealed partial class DeleteAsyncSearchRequest : PlainRequest<DeleteAsyncSearchRequestParameters>
4045
{
@@ -52,7 +57,12 @@ public DeleteAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Id id)
5257
}
5358

5459
/// <summary>
55-
/// <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>
60+
/// <para>
61+
/// Deletes an async search by identifier.
62+
/// If the search is still running, the search request will be cancelled.
63+
/// Otherwise, the saved search results are deleted.
64+
/// 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.
65+
/// </para>
5666
/// </summary>
5767
public sealed partial class DeleteAsyncSearchRequestDescriptor<TDocument> : RequestDescriptor<DeleteAsyncSearchRequestDescriptor<TDocument>, DeleteAsyncSearchRequestParameters>
5868
{
@@ -82,7 +92,12 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
8292
}
8393

8494
/// <summary>
85-
/// <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>
95+
/// <para>
96+
/// Deletes an async search by identifier.
97+
/// If the search is still running, the search request will be cancelled.
98+
/// Otherwise, the saved search results are deleted.
99+
/// 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.
100+
/// </para>
86101
/// </summary>
87102
public sealed partial class DeleteAsyncSearchRequestDescriptor : RequestDescriptor<DeleteAsyncSearchRequestDescriptor, DeleteAsyncSearchRequestParameters>
88103
{

Diff for: ‎src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/DeleteAsyncSearchResponse.g.cs

+3-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ namespace Elastic.Clients.Elasticsearch.Serverless.AsyncSearch;
2929
public sealed partial class DeleteAsyncSearchResponse : ElasticsearchResponse
3030
{
3131
/// <summary>
32-
/// <para>For a successful response, this value is always true. On failure, an exception is returned instead.</para>
32+
/// <para>
33+
/// For a successful response, this value is always true. On failure, an exception is returned instead.
34+
/// </para>
3335
/// </summary>
3436
[JsonInclude, JsonPropertyName("acknowledged")]
3537
public bool Acknowledged { get; init; }

Diff for: ‎src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs

+42-9
Original file line numberDiff line numberDiff line change
@@ -32,23 +32,38 @@ namespace Elastic.Clients.Elasticsearch.Serverless.AsyncSearch;
3232
public sealed partial class GetAsyncSearchRequestParameters : RequestParameters
3333
{
3434
/// <summary>
35-
/// <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>
35+
/// <para>
36+
/// Specifies how long the async search should be available in the cluster.
37+
/// When not specified, the <c>keep_alive</c> set with the corresponding submit async request will be used.
38+
/// Otherwise, it is possible to override the value and extend the validity of the request.
39+
/// When this period expires, the search, if still running, is cancelled.
40+
/// If the search is completed, its saved results are deleted.
41+
/// </para>
3642
/// </summary>
3743
public Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAlive { get => Q<Elastic.Clients.Elasticsearch.Serverless.Duration?>("keep_alive"); set => Q("keep_alive", value); }
3844

3945
/// <summary>
40-
/// <para>Specify whether aggregation and suggester names should be prefixed by their respective types in the response</para>
46+
/// <para>
47+
/// Specify whether aggregation and suggester names should be prefixed by their respective types in the response
48+
/// </para>
4149
/// </summary>
4250
public bool? TypedKeys { get => Q<bool?>("typed_keys"); set => Q("typed_keys", value); }
4351

4452
/// <summary>
45-
/// <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>
53+
/// <para>
54+
/// Specifies to wait for the search to be completed up until the provided timeout.
55+
/// Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.
56+
/// By default no timeout is set meaning that the currently available results will be returned without any additional wait.
57+
/// </para>
4658
/// </summary>
4759
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); }
4860
}
4961

5062
/// <summary>
51-
/// <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>
63+
/// <para>
64+
/// Retrieves the results of a previously submitted async search request given its identifier.
65+
/// 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.
66+
/// </para>
5267
/// </summary>
5368
public sealed partial class GetAsyncSearchRequest : PlainRequest<GetAsyncSearchRequestParameters>
5469
{
@@ -65,26 +80,41 @@ public GetAsyncSearchRequest(Elastic.Clients.Elasticsearch.Serverless.Id id) : b
6580
internal override string OperationName => "async_search.get";
6681

6782
/// <summary>
68-
/// <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>
83+
/// <para>
84+
/// Specifies how long the async search should be available in the cluster.
85+
/// When not specified, the <c>keep_alive</c> set with the corresponding submit async request will be used.
86+
/// Otherwise, it is possible to override the value and extend the validity of the request.
87+
/// When this period expires, the search, if still running, is cancelled.
88+
/// If the search is completed, its saved results are deleted.
89+
/// </para>
6990
/// </summary>
7091
[JsonIgnore]
7192
public Elastic.Clients.Elasticsearch.Serverless.Duration? KeepAlive { get => Q<Elastic.Clients.Elasticsearch.Serverless.Duration?>("keep_alive"); set => Q("keep_alive", value); }
7293

7394
/// <summary>
74-
/// <para>Specify whether aggregation and suggester names should be prefixed by their respective types in the response</para>
95+
/// <para>
96+
/// Specify whether aggregation and suggester names should be prefixed by their respective types in the response
97+
/// </para>
7598
/// </summary>
7699
[JsonIgnore]
77100
public bool? TypedKeys { get => Q<bool?>("typed_keys"); set => Q("typed_keys", value); }
78101

79102
/// <summary>
80-
/// <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>
103+
/// <para>
104+
/// Specifies to wait for the search to be completed up until the provided timeout.
105+
/// Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires.
106+
/// By default no timeout is set meaning that the currently available results will be returned without any additional wait.
107+
/// </para>
81108
/// </summary>
82109
[JsonIgnore]
83110
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); }
84111
}
85112

86113
/// <summary>
87-
/// <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>
114+
/// <para>
115+
/// Retrieves the results of a previously submitted async search request given its identifier.
116+
/// 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.
117+
/// </para>
88118
/// </summary>
89119
public sealed partial class GetAsyncSearchRequestDescriptor<TDocument> : RequestDescriptor<GetAsyncSearchRequestDescriptor<TDocument>, GetAsyncSearchRequestParameters>
90120
{
@@ -118,7 +148,10 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
118148
}
119149

120150
/// <summary>
121-
/// <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>
151+
/// <para>
152+
/// Retrieves the results of a previously submitted async search request given its identifier.
153+
/// 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.
154+
/// </para>
122155
/// </summary>
123156
public sealed partial class GetAsyncSearchRequestDescriptor : RequestDescriptor<GetAsyncSearchRequestDescriptor, GetAsyncSearchRequestParameters>
124157
{

Diff for: ‎src/Elastic.Clients.Elasticsearch.Serverless/_Generated/Api/AsyncSearch/GetAsyncSearchResponse.g.cs

+15-4
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,20 @@ namespace Elastic.Clients.Elasticsearch.Serverless.AsyncSearch;
2929
public sealed partial class GetAsyncSearchResponse<TDocument> : ElasticsearchResponse
3030
{
3131
/// <summary>
32-
/// <para>Indicates when the async search completed. Only present<br/>when the search has completed.</para>
32+
/// <para>
33+
/// Indicates when the async search completed. Only present
34+
/// when the search has completed.
35+
/// </para>
3336
/// </summary>
3437
[JsonInclude, JsonPropertyName("completion_time")]
3538
public DateTimeOffset? CompletionTime { get; init; }
3639
[JsonInclude, JsonPropertyName("completion_time_in_millis")]
3740
public long? CompletionTimeInMillis { get; init; }
3841

3942
/// <summary>
40-
/// <para>Indicates when the async search will expire.</para>
43+
/// <para>
44+
/// Indicates when the async search will expire.
45+
/// </para>
4146
/// </summary>
4247
[JsonInclude, JsonPropertyName("expiration_time")]
4348
public DateTimeOffset? ExpirationTime { get; init; }
@@ -47,13 +52,19 @@ public sealed partial class GetAsyncSearchResponse<TDocument> : ElasticsearchRes
4752
public string? Id { get; init; }
4853

4954
/// <summary>
50-
/// <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>
55+
/// <para>
56+
/// When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards.
57+
/// While the query is running, <c>is_partial</c> is always set to <c>true</c>.
58+
/// </para>
5159
/// </summary>
5260
[JsonInclude, JsonPropertyName("is_partial")]
5361
public bool IsPartial { get; init; }
5462

5563
/// <summary>
56-
/// <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>
64+
/// <para>
65+
/// Indicates whether the search is still running or has completed.
66+
/// 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>.
67+
/// </para>
5768
/// </summary>
5869
[JsonInclude, JsonPropertyName("is_running")]
5970
public bool IsRunning { get; init; }

0 commit comments

Comments
 (0)