Skip to content

Commit 74df9a3

Browse files
github-actions[bot]stevejgordon
github-actions[bot]
and
stevejgordon
authored
Code generate XML doc comments. (#7411) (#7416)
* Add XML doc comments for client methods Includes many formatting changes in other files due to code gen changes required for XML docs. * Add XML doc comments for classes * Add XML doc comments for properties * Add XML doc comments for requests * Add XML doc comments for enums * Rename ApiUrlLookup and fix leading trivia Co-authored-by: Steve Gordon <sgordon@hotmail.co.uk>
1 parent 30aec1c commit 74df9a3

File tree

864 files changed

+12065
-10983
lines changed

Some content is hidden

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

864 files changed

+12065
-10983
lines changed

‎src/Elastic.Clients.Elasticsearch/_Generated/Api/ApiUrlsLookup.g.cs renamed to ‎src/Elastic.Clients.Elasticsearch/_Generated/Api/ApiUrlLookup.g.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,11 @@
1515
//
1616
// ------------------------------------------------
1717

18+
#nullable restore
19+
1820
namespace Elastic.Clients.Elasticsearch.Requests;
19-
internal static class ApiUrlsLookups
21+
22+
internal static class ApiUrlLookup
2023
{
2124
internal static ApiUrls AsyncSearchStatus = new ApiUrls(new[] { "/_async_search/status/{id}" });
2225
internal static ApiUrls AsyncSearchDelete = new ApiUrls(new[] { "/_async_search/{id}" });

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

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
//
1616
// ------------------------------------------------
1717

18+
#nullable restore
19+
1820
using Elastic.Clients.Elasticsearch.Fluent;
1921
using Elastic.Clients.Elasticsearch.Requests;
2022
using Elastic.Clients.Elasticsearch.Serialization;
@@ -25,26 +27,35 @@
2527
using System.Text.Json;
2628
using System.Text.Json.Serialization;
2729

28-
#nullable restore
2930
namespace Elastic.Clients.Elasticsearch.AsyncSearch;
31+
3032
public sealed class AsyncSearchStatusRequestParameters : RequestParameters
3133
{
3234
}
3335

36+
/// <summary>
37+
/// <para>Retrieves the status of a previously submitted async search request given its ID.</para>
38+
/// </summary>
3439
public sealed partial class AsyncSearchStatusRequest : PlainRequest<AsyncSearchStatusRequestParameters>
3540
{
3641
public AsyncSearchStatusRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
3742
{
3843
}
3944

40-
internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchStatus;
45+
internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchStatus;
46+
4147
protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
48+
4249
internal override bool SupportsBody => false;
4350
}
4451

52+
/// <summary>
53+
/// <para>Retrieves the status of a previously submitted async search request given its ID.</para>
54+
/// </summary>
4555
public sealed partial class AsyncSearchStatusRequestDescriptor<TDocument> : RequestDescriptor<AsyncSearchStatusRequestDescriptor<TDocument>, AsyncSearchStatusRequestParameters>
4656
{
4757
internal AsyncSearchStatusRequestDescriptor(Action<AsyncSearchStatusRequestDescriptor<TDocument>> configure) => configure.Invoke(this);
58+
4859
public AsyncSearchStatusRequestDescriptor(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
4960
{
5061
}
@@ -53,9 +64,12 @@ internal AsyncSearchStatusRequestDescriptor()
5364
{
5465
}
5566

56-
internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchStatus;
67+
internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchStatus;
68+
5769
protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
70+
5871
internal override bool SupportsBody => false;
72+
5973
public AsyncSearchStatusRequestDescriptor<TDocument> Id(Elastic.Clients.Elasticsearch.Id id)
6074
{
6175
RouteValues.Required("id", id);
@@ -67,9 +81,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
6781
}
6882
}
6983

84+
/// <summary>
85+
/// <para>Retrieves the status of a previously submitted async search request given its ID.</para>
86+
/// </summary>
7087
public sealed partial class AsyncSearchStatusRequestDescriptor : RequestDescriptor<AsyncSearchStatusRequestDescriptor, AsyncSearchStatusRequestParameters>
7188
{
7289
internal AsyncSearchStatusRequestDescriptor(Action<AsyncSearchStatusRequestDescriptor> configure) => configure.Invoke(this);
90+
7391
public AsyncSearchStatusRequestDescriptor(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
7492
{
7593
}
@@ -78,9 +96,12 @@ internal AsyncSearchStatusRequestDescriptor()
7896
{
7997
}
8098

81-
internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchStatus;
99+
internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchStatus;
100+
82101
protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
102+
83103
internal override bool SupportsBody => false;
104+
84105
public AsyncSearchStatusRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id)
85106
{
86107
RouteValues.Required("id", id);

‎src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/AsyncSearchStatusResponse.g.cs

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,41 +15,35 @@
1515
//
1616
// ------------------------------------------------
1717

18+
#nullable restore
19+
1820
using Elastic.Clients.Elasticsearch.Fluent;
1921
using Elastic.Clients.Elasticsearch.Serialization;
2022
using Elastic.Transport.Products.Elasticsearch;
2123
using System;
2224
using System.Collections.Generic;
2325
using System.Text.Json.Serialization;
2426

25-
#nullable restore
2627
namespace Elastic.Clients.Elasticsearch.AsyncSearch;
28+
2729
public sealed partial class AsyncSearchStatusResponse : ElasticsearchResponse
2830
{
2931
[JsonInclude, JsonPropertyName("completion_status")]
3032
public int? CompletionStatus { get; init; }
31-
3233
[JsonInclude, JsonPropertyName("expiration_time")]
3334
public DateTimeOffset? ExpirationTime { get; init; }
34-
3535
[JsonInclude, JsonPropertyName("expiration_time_in_millis")]
3636
public long ExpirationTimeInMillis { get; init; }
37-
3837
[JsonInclude, JsonPropertyName("id")]
3938
public string? Id { get; init; }
40-
4139
[JsonInclude, JsonPropertyName("is_partial")]
4240
public bool IsPartial { get; init; }
43-
4441
[JsonInclude, JsonPropertyName("is_running")]
4542
public bool IsRunning { get; init; }
46-
4743
[JsonInclude, JsonPropertyName("_shards")]
4844
public Elastic.Clients.Elasticsearch.ShardStatistics Shards { get; init; }
49-
5045
[JsonInclude, JsonPropertyName("start_time")]
5146
public DateTimeOffset? StartTime { get; init; }
52-
5347
[JsonInclude, JsonPropertyName("start_time_in_millis")]
5448
public long StartTimeInMillis { get; init; }
5549
}

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

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
//
1616
// ------------------------------------------------
1717

18+
#nullable restore
19+
1820
using Elastic.Clients.Elasticsearch.Fluent;
1921
using Elastic.Clients.Elasticsearch.Requests;
2022
using Elastic.Clients.Elasticsearch.Serialization;
@@ -25,26 +27,35 @@
2527
using System.Text.Json;
2628
using System.Text.Json.Serialization;
2729

28-
#nullable restore
2930
namespace Elastic.Clients.Elasticsearch.AsyncSearch;
31+
3032
public sealed class DeleteAsyncSearchRequestParameters : RequestParameters
3133
{
3234
}
3335

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>
3439
public sealed partial class DeleteAsyncSearchRequest : PlainRequest<DeleteAsyncSearchRequestParameters>
3540
{
3641
public DeleteAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
3742
{
3843
}
3944

40-
internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchDelete;
45+
internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchDelete;
46+
4147
protected override HttpMethod StaticHttpMethod => HttpMethod.DELETE;
48+
4249
internal override bool SupportsBody => false;
4350
}
4451

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>
4555
public sealed partial class DeleteAsyncSearchRequestDescriptor<TDocument> : RequestDescriptor<DeleteAsyncSearchRequestDescriptor<TDocument>, DeleteAsyncSearchRequestParameters>
4656
{
4757
internal DeleteAsyncSearchRequestDescriptor(Action<DeleteAsyncSearchRequestDescriptor<TDocument>> configure) => configure.Invoke(this);
58+
4859
public DeleteAsyncSearchRequestDescriptor(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
4960
{
5061
}
@@ -53,9 +64,12 @@ internal DeleteAsyncSearchRequestDescriptor()
5364
{
5465
}
5566

56-
internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchDelete;
67+
internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchDelete;
68+
5769
protected override HttpMethod StaticHttpMethod => HttpMethod.DELETE;
70+
5871
internal override bool SupportsBody => false;
72+
5973
public DeleteAsyncSearchRequestDescriptor<TDocument> Id(Elastic.Clients.Elasticsearch.Id id)
6074
{
6175
RouteValues.Required("id", id);
@@ -67,9 +81,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
6781
}
6882
}
6983

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>
7087
public sealed partial class DeleteAsyncSearchRequestDescriptor : RequestDescriptor<DeleteAsyncSearchRequestDescriptor, DeleteAsyncSearchRequestParameters>
7188
{
7289
internal DeleteAsyncSearchRequestDescriptor(Action<DeleteAsyncSearchRequestDescriptor> configure) => configure.Invoke(this);
90+
7391
public DeleteAsyncSearchRequestDescriptor(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
7492
{
7593
}
@@ -78,9 +96,12 @@ internal DeleteAsyncSearchRequestDescriptor()
7896
{
7997
}
8098

81-
internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchDelete;
99+
internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchDelete;
100+
82101
protected override HttpMethod StaticHttpMethod => HttpMethod.DELETE;
102+
83103
internal override bool SupportsBody => false;
104+
84105
public DeleteAsyncSearchRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id)
85106
{
86107
RouteValues.Required("id", id);

‎src/Elastic.Clients.Elasticsearch/_Generated/Api/AsyncSearch/DeleteAsyncSearchResponse.g.cs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,21 @@
1515
//
1616
// ------------------------------------------------
1717

18+
#nullable restore
19+
1820
using Elastic.Clients.Elasticsearch.Fluent;
1921
using Elastic.Clients.Elasticsearch.Serialization;
2022
using Elastic.Transport.Products.Elasticsearch;
2123
using System.Collections.Generic;
2224
using System.Text.Json.Serialization;
2325

24-
#nullable restore
2526
namespace Elastic.Clients.Elasticsearch.AsyncSearch;
27+
2628
public sealed partial class DeleteAsyncSearchResponse : ElasticsearchResponse
2729
{
30+
/// <summary>
31+
/// <para>For a successful response, this value is always true. On failure, an exception is returned instead.</para>
32+
/// </summary>
2833
[JsonInclude, JsonPropertyName("acknowledged")]
2934
public bool Acknowledged { get; init; }
3035
}

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

Lines changed: 46 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
//
1616
// ------------------------------------------------
1717

18+
#nullable restore
19+
1820
using Elastic.Clients.Elasticsearch.Fluent;
1921
using Elastic.Clients.Elasticsearch.Requests;
2022
using Elastic.Clients.Elasticsearch.Serialization;
@@ -25,42 +27,67 @@
2527
using System.Text.Json;
2628
using System.Text.Json.Serialization;
2729

28-
#nullable restore
2930
namespace Elastic.Clients.Elasticsearch.AsyncSearch;
31+
3032
public sealed class GetAsyncSearchRequestParameters : RequestParameters
3133
{
32-
[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>
3337
public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q<Elastic.Clients.Elasticsearch.Duration?>("keep_alive"); set => Q("keep_alive", value); }
3438

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

38-
[JsonIgnore]
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))
4556
{
4657
}
4758

48-
internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchGet;
59+
internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchGet;
60+
4961
protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
62+
5063
internal override bool SupportsBody => false;
64+
65+
/// <summary>
66+
/// <para>Specify the time interval in which the results (partial or final) for this search will be available</para>
67+
/// </summary>
5168
[JsonIgnore]
5269
public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q<Elastic.Clients.Elasticsearch.Duration?>("keep_alive"); set => Q("keep_alive", value); }
5370

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

77+
/// <summary>
78+
/// <para>Specify the time that the request should block waiting for the final response</para>
79+
/// </summary>
5780
[JsonIgnore]
5881
public Elastic.Clients.Elasticsearch.Duration? WaitForCompletionTimeout { get => Q<Elastic.Clients.Elasticsearch.Duration?>("wait_for_completion_timeout"); set => Q("wait_for_completion_timeout", value); }
5982
}
6083

84+
/// <summary>
85+
/// <para>Retrieves the results of a previously submitted async search request given its ID.</para>
86+
/// </summary>
6187
public sealed partial class GetAsyncSearchRequestDescriptor<TDocument> : RequestDescriptor<GetAsyncSearchRequestDescriptor<TDocument>, GetAsyncSearchRequestParameters>
6288
{
6389
internal GetAsyncSearchRequestDescriptor(Action<GetAsyncSearchRequestDescriptor<TDocument>> configure) => configure.Invoke(this);
90+
6491
public GetAsyncSearchRequestDescriptor(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
6592
{
6693
}
@@ -69,12 +96,16 @@ internal GetAsyncSearchRequestDescriptor()
6996
{
7097
}
7198

72-
internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchGet;
99+
internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchGet;
100+
73101
protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
102+
74103
internal override bool SupportsBody => false;
104+
75105
public GetAsyncSearchRequestDescriptor<TDocument> KeepAlive(Elastic.Clients.Elasticsearch.Duration? keepAlive) => Qs("keep_alive", keepAlive);
76106
public GetAsyncSearchRequestDescriptor<TDocument> TypedKeys(bool? typedKeys = true) => Qs("typed_keys", typedKeys);
77107
public GetAsyncSearchRequestDescriptor<TDocument> WaitForCompletionTimeout(Elastic.Clients.Elasticsearch.Duration? waitForCompletionTimeout) => Qs("wait_for_completion_timeout", waitForCompletionTimeout);
108+
78109
public GetAsyncSearchRequestDescriptor<TDocument> Id(Elastic.Clients.Elasticsearch.Id id)
79110
{
80111
RouteValues.Required("id", id);
@@ -86,9 +117,13 @@ protected override void Serialize(Utf8JsonWriter writer, JsonSerializerOptions o
86117
}
87118
}
88119

120+
/// <summary>
121+
/// <para>Retrieves the results of a previously submitted async search request given its ID.</para>
122+
/// </summary>
89123
public sealed partial class GetAsyncSearchRequestDescriptor : RequestDescriptor<GetAsyncSearchRequestDescriptor, GetAsyncSearchRequestParameters>
90124
{
91125
internal GetAsyncSearchRequestDescriptor(Action<GetAsyncSearchRequestDescriptor> configure) => configure.Invoke(this);
126+
92127
public GetAsyncSearchRequestDescriptor(Elastic.Clients.Elasticsearch.Id id) : base(r => r.Required("id", id))
93128
{
94129
}
@@ -97,12 +132,16 @@ internal GetAsyncSearchRequestDescriptor()
97132
{
98133
}
99134

100-
internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchGet;
135+
internal override ApiUrls ApiUrls => ApiUrlLookup.AsyncSearchGet;
136+
101137
protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
138+
102139
internal override bool SupportsBody => false;
140+
103141
public GetAsyncSearchRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Duration? keepAlive) => Qs("keep_alive", keepAlive);
104142
public GetAsyncSearchRequestDescriptor TypedKeys(bool? typedKeys = true) => Qs("typed_keys", typedKeys);
105143
public GetAsyncSearchRequestDescriptor WaitForCompletionTimeout(Elastic.Clients.Elasticsearch.Duration? waitForCompletionTimeout) => Qs("wait_for_completion_timeout", waitForCompletionTimeout);
144+
106145
public GetAsyncSearchRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id)
107146
{
108147
RouteValues.Required("id", id);

0 commit comments

Comments
 (0)