Skip to content

Commit 50f3df6

Browse files
committed
Add XML doc comments for requests
1 parent bb57040 commit 50f3df6

File tree

112 files changed

+4181
-450
lines changed

Some content is hidden

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

112 files changed

+4181
-450
lines changed

src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusRequest.g.cs

+9
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ public sealed class AsyncSearchStatusRequestParameters : RequestParameters
3333
{
3434
}
3535

36+
/// <summary>
37+
/// <para>Retrieves the status of a previously submitted async search request given its ID.</para>
38+
/// </summary>
3639
public sealed partial class AsyncSearchStatusRequest : PlainRequest<AsyncSearchStatusRequestParameters>
3740
{
3841
public AsyncSearchStatusRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
@@ -46,6 +49,9 @@ public AsyncSearchStatusRequest(Elastic.Clients.Elasticsearch.Id id) : base(r =>
4649
internal override bool SupportsBody => false;
4750
}
4851

52+
/// <summary>
53+
/// <para>Retrieves the status of a previously submitted async search request given its ID.</para>
54+
/// </summary>
4955
public sealed partial class AsyncSearchStatusRequestDescriptor<TDocument> : RequestDescriptor<AsyncSearchStatusRequestDescriptor<TDocument>, AsyncSearchStatusRequestParameters>
5056
{
5157
internal AsyncSearchStatusRequestDescriptor(Action<AsyncSearchStatusRequestDescriptor<TDocument>> configure) => configure.Invoke(this);
@@ -75,6 +81,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
7581
}
7682
}
7783

84+
/// <summary>
85+
/// <para>Retrieves the status of a previously submitted async search request given its ID.</para>
86+
/// </summary>
7887
public sealed partial class AsyncSearchStatusRequestDescriptor : RequestDescriptor<AsyncSearchStatusRequestDescriptor, AsyncSearchStatusRequestParameters>
7988
{
8089
internal AsyncSearchStatusRequestDescriptor(Action<AsyncSearchStatusRequestDescriptor> configure) => configure.Invoke(this);

src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchRequest.g.cs

+9
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ public sealed class DeleteAsyncSearchRequestParameters : RequestParameters
3333
{
3434
}
3535

36+
/// <summary>
37+
/// <para>Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.</para>
38+
/// </summary>
3639
public sealed partial class DeleteAsyncSearchRequest : PlainRequest<DeleteAsyncSearchRequestParameters>
3740
{
3841
public DeleteAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
@@ -46,6 +49,9 @@ public DeleteAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r =>
4649
internal override bool SupportsBody => false;
4750
}
4851

52+
/// <summary>
53+
/// <para>Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.</para>
54+
/// </summary>
4955
public sealed partial class DeleteAsyncSearchRequestDescriptor<TDocument> : RequestDescriptor<DeleteAsyncSearchRequestDescriptor<TDocument>, DeleteAsyncSearchRequestParameters>
5056
{
5157
internal DeleteAsyncSearchRequestDescriptor(Action<DeleteAsyncSearchRequestDescriptor<TDocument>> configure) => configure.Invoke(this);
@@ -75,6 +81,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
7581
}
7682
}
7783

84+
/// <summary>
85+
/// <para>Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted.</para>
86+
/// </summary>
7887
public sealed partial class DeleteAsyncSearchRequestDescriptor : RequestDescriptor<DeleteAsyncSearchRequestDescriptor, DeleteAsyncSearchRequestParameters>
7988
{
8089
internal DeleteAsyncSearchRequestDescriptor(Action<DeleteAsyncSearchRequestDescriptor> configure) => configure.Invoke(this);

src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/GetAsyncSearchRequest.g.cs

+31-3
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,25 @@ namespace Elastic.Clients.Elasticsearch.AsyncSearch;
3131

3232
public sealed class GetAsyncSearchRequestParameters : RequestParameters
3333
{
34-
[JsonIgnore]
34+
/// <summary>
35+
/// <para>Specify the time interval in which the results (partial or final) for this search will be available</para>
36+
/// </summary>
3537
public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q<Elastic.Clients.Elasticsearch.Duration?>("keep_alive"); set => Q("keep_alive", value); }
36-
[JsonIgnore]
38+
39+
/// <summary>
40+
/// <para>Specify whether aggregation and suggester names should be prefixed by their respective types in the response</para>
41+
/// </summary>
3742
public bool? TypedKeys { get => Q<bool?>("typed_keys"); set => Q("typed_keys", value); }
38-
[JsonIgnore]
43+
44+
/// <summary>
45+
/// <para>Specify the time that the request should block waiting for the final response</para>
46+
/// </summary>
3947
public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q<Elastic.Clients.Elasticsearch.Duration?>("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); }
4048
}
4149

50+
/// <summary>
51+
/// <para>Retrieves the results of a previously submitted async search request given its ID.</para>
52+
/// </summary>
4253
public sealed partial class GetAsyncSearchRequest : PlainRequest<GetAsyncSearchRequestParameters>
4354
{
4455
public GetAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
@@ -51,14 +62,28 @@ public GetAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.
5162

5263
internal override bool SupportsBody => false;
5364

65+
/// <summary>
66+
/// <para>Specify the time interval in which the results (partial or final) for this search will be available</para>
67+
/// </summary>
5468
[JsonIgnore]
5569
public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q<Elastic.Clients.Elasticsearch.Duration?>("keep_alive"); set => Q("keep_alive", value); }
70+
71+
/// <summary>
72+
/// <para>Specify whether aggregation and suggester names should be prefixed by their respective types in the response</para>
73+
/// </summary>
5674
[JsonIgnore]
5775
public bool? TypedKeys { get => Q<bool?>("typed_keys"); set => Q("typed_keys", value); }
76+
77+
/// <summary>
78+
/// <para>Specify the time that the request should block waiting for the final response</para>
79+
/// </summary>
5880
[JsonIgnore]
5981
public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q<Elastic.Clients.Elasticsearch.Duration?>("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); }
6082
}
6183

84+
/// <summary>
85+
/// <para>Retrieves the results of a previously submitted async search request given its ID.</para>
86+
/// </summary>
6287
public sealed partial class GetAsyncSearchRequestDescriptor<TDocument> : RequestDescriptor<GetAsyncSearchRequestDescriptor<TDocument>, GetAsyncSearchRequestParameters>
6388
{
6489
internal GetAsyncSearchRequestDescriptor(Action<GetAsyncSearchRequestDescriptor<TDocument>> configure) => configure.Invoke(this);
@@ -92,6 +117,9 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
92117
}
93118
}
94119

120+
/// <summary>
121+
/// <para>Retrieves the results of a previously submitted async search request given its ID.</para>
122+
/// </summary>
95123
public sealed partial class GetAsyncSearchRequestDescriptor : RequestDescriptor<GetAsyncSearchRequestDescriptor, GetAsyncSearchRequestParameters>
96124
{
97125
internal GetAsyncSearchRequestDescriptor(Action<GetAsyncSearchRequestDescriptor> configure) => configure.Invoke(this);

0 commit comments

Comments
 (0)