Fix to ensure dynamic HTTP methods are used when available (#7058) (#7059)

Co-authored-by: Steve Gordon <[email protected]>

Author: github-actions[bot]

src/Elastic.Clients.Elasticsearch/Api/IndexRequest.cs

@@ -14,8 +14,6 @@ public partial class IndexRequest<TDocument> : ICustomJsonWriter
 {
 	public IndexRequest() : this(typeof(TDocument)) { }
 
-	//public IndexRequest(TDocument document) : this(typeof(TDocument)) => Document = document;
-
 	public IndexRequest(TDocument document, Id id) : this(typeof(TDocument), id) => Document = document;
 
 	protected override HttpMethod? DynamicHttpMethod => GetHttpMethod(this);
@@ -34,7 +32,6 @@ internal static HttpMethod GetHttpMethod(IndexRequest<TDocument> request) =>
 
 public sealed partial class IndexRequestDescriptor<TDocument> : ICustomJsonWriter
 {
-	// TODO: Codegen
 	public IndexRequestDescriptor<TDocument> Document(TDocument document)
 	{
 		DocumentValue = document;

src/Elastic.Clients.Elasticsearch/Core/Fluent/Descriptor.cs

@@ -14,7 +14,7 @@ namespace Elastic.Clients.Elasticsearch.Fluent;
 
 public abstract class Descriptor
 {
-	// This internal ctor ensures that only types defined within the client assembly can derive from this base class.
+	// This internal ctor ensures that only types defined within the Elastic.Clients.Elasticsearch assembly can derive from this base class.
 	// We don't expect consumers to derive from this public base class.
 	internal Descriptor() { }
 
@@ -49,7 +49,7 @@ public abstract class Descriptor<TDescriptor> : Descriptor
 {
 	private readonly TDescriptor _self;
 
-	// This internal ctor ensures that only types defined within the client assembly can derive from this base class.
+	// This internal ctor ensures that only types defined within the Elastic.Clients.Elasticsearch assembly can derive from this base class.
 	// We don't expect consumers to derive from this public base class.
 	internal Descriptor() : base() => _self = (TDescriptor)this;
 
@@ -64,7 +64,7 @@ public abstract class Descriptor<TDescriptor> : Descriptor
 public abstract class SerializableDescriptor<TDescriptor> : Descriptor<TDescriptor>, ISelfSerializable
 	where TDescriptor : SerializableDescriptor<TDescriptor>
 {
-	// This internal ctor ensures that only types defined within the client assembly can derive from this base class.
+	// This internal ctor ensures that only types defined within the Elastic.Clients.Elasticsearch assembly can derive from this base class.
 	// We don't expect consumers to derive from this public base class.
 	internal SerializableDescriptor(): base() { }
 

src/Elastic.Clients.Elasticsearch/Core/Fluent/Promise/IsADictionaryDescriptor.cs

@@ -11,7 +11,7 @@ public abstract class IsADictionaryDescriptor<TDescriptor, TPromised, TKey, TVal
 	where TDescriptor : IsADictionaryDescriptor<TDescriptor, TPromised, TKey, TValue>
 	where TPromised : class, IIsADictionary<TKey, TValue>
 {
-	// This internal ctor ensures that only types defined within the client assembly can derive from this base class.
+	// This internal ctor ensures that only types defined within the Elastic.Clients.Elasticsearch assembly can derive from this base class.
 	// We don't expect consumers to derive from this public base class.
 	internal IsADictionaryDescriptor(TPromised instance) : base(instance) { }
 

src/Elastic.Clients.Elasticsearch/Core/Fluent/Promise/PromiseDescriptor.cs

@@ -12,7 +12,7 @@ public abstract class PromiseDescriptor<TDescriptor, TValue> : Descriptor, IProm
 {
 	internal readonly TValue PromisedValue;
 
-	// This internal ctor ensures that only types defined within the client assembly can derive from this base class.
+	// This internal ctor ensures that only types defined within the Elastic.Clients.Elasticsearch assembly can derive from this base class.
 	// We don't expect consumers to derive from this public base class.
 	internal PromiseDescriptor(TValue instance) : base()
 	{

src/Elastic.Clients.Elasticsearch/Core/Request/PlainRequest.cs

@@ -11,7 +11,7 @@ namespace Elastic.Clients.Elasticsearch.Requests;
 public abstract class PlainRequest<TParameters> : Request<TParameters>
 	where TParameters : RequestParameters, new()
 {
-	// This internal ctor ensures that only types defined within the client assembly can derive from this base class.
+	// This internal ctor ensures that only types defined within the Elastic.Clients.Elasticsearch assembly can derive from this base class.
 	// We don't expect consumers to derive from this public base class.
 	internal PlainRequest() { }
 

src/Elastic.Clients.Elasticsearch/Core/Request/Request.cs

@@ -8,21 +8,43 @@
 
 namespace Elastic.Clients.Elasticsearch.Requests;
 
+/// <summary>
+/// Base type for requests sent by the client.
+/// </summary>
 public abstract class Request
 {
+	// This internal ctor ensures that only types defined within the Elastic.Clients.Elasticsearch assembly can derive from this base class.
+	// We don't expect consumers to derive from this public base class.
 	internal Request() { }
 
 	internal virtual string? Accept { get; } = null;
 
 	internal virtual string? ContentType { get; } = null;
 
-	[JsonIgnore] internal abstract HttpMethod HttpMethod { get; }
-
-	[JsonIgnore] internal abstract bool SupportsBody { get; }
-
-	[JsonIgnore] protected RouteValues RouteValues { get; } = new();
-
-	[JsonIgnore] protected virtual HttpMethod? DynamicHttpMethod => null;
+	/// <summary>
+	/// The default HTTP method for the request which is based on the Elasticsearch Specification endpoint definition. 
+	/// </summary>
+	[JsonIgnore]
+	protected abstract HttpMethod StaticHttpMethod { get; }
+
+	[JsonIgnore]
+	internal abstract bool SupportsBody { get; }
+
+	[JsonIgnore]
+	protected RouteValues RouteValues { get; } = new();
+
+	/// <summary>
+	/// Allows for per request replacement of the specified HTTP method, including scenarios such as indexing which
+	/// require access to the document to determine the correct URL path and method combination to choose.
+	/// </summary>
+	[JsonIgnore]
+	protected virtual HttpMethod? DynamicHttpMethod => null;
+
+	/// <summary>
+	/// The final HTTP method used to send the request to the Elasticsearch server.
+	/// </summary>
+	[JsonIgnore]
+	internal HttpMethod HttpMethod => DynamicHttpMethod ?? StaticHttpMethod;
 
 	internal abstract ApiUrls ApiUrls { get; }
 

src/Elastic.Clients.Elasticsearch/Core/Request/RequestDescriptor.cs

@@ -21,7 +21,7 @@ public abstract partial class RequestDescriptor<TDescriptor, TParameters> : Requ
 
 	void ISelfSerializable.Serialize(Utf8JsonWriter writer, JsonSerializerOptions options, IElasticsearchClientSettings settings) => Serialize(writer, options, settings);
 
-	// This internal ctor ensures that only types defined within the client assembly can derive from this base class.
+	// This internal ctor ensures that only types defined within the Elastic.Clients.Elasticsearch assembly can derive from this base class.
 	// We don't expect consumers to derive from this public base class.
 	internal RequestDescriptor() => _descriptor = (TDescriptor)this;
 

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

@@ -38,7 +38,7 @@ public AsyncSearchStatusRequest(Elastic.Clients.Elasticsearch.Id id) : base(r =>
 	}
 
 	internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchStatus;
-	internal override HttpMethod HttpMethod => HttpMethod.GET;
+	protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
 	internal override bool SupportsBody => false;
 }
 
@@ -54,7 +54,7 @@ internal AsyncSearchStatusRequestDescriptor()
 	}
 
 	internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchStatus;
-	internal override HttpMethod HttpMethod => HttpMethod.GET;
+	protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
 	internal override bool SupportsBody => false;
 	public AsyncSearchStatusRequestDescriptor<TDocument> Id(Elastic.Clients.Elasticsearch.Id id)
 	{
@@ -79,7 +79,7 @@ internal AsyncSearchStatusRequestDescriptor()
 	}
 
 	internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchStatus;
-	internal override HttpMethod HttpMethod => HttpMethod.GET;
+	protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
 	internal override bool SupportsBody => false;
 	public AsyncSearchStatusRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id)
 	{

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

@@ -38,7 +38,7 @@ public DeleteAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r =>
 	}
 
 	internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchDelete;
-	internal override HttpMethod HttpMethod => HttpMethod.DELETE;
+	protected override HttpMethod StaticHttpMethod => HttpMethod.DELETE;
 	internal override bool SupportsBody => false;
 }
 
@@ -54,7 +54,7 @@ internal DeleteAsyncSearchRequestDescriptor()
 	}
 
 	internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchDelete;
-	internal override HttpMethod HttpMethod => HttpMethod.DELETE;
+	protected override HttpMethod StaticHttpMethod => HttpMethod.DELETE;
 	internal override bool SupportsBody => false;
 	public DeleteAsyncSearchRequestDescriptor<TDocument> Id(Elastic.Clients.Elasticsearch.Id id)
 	{
@@ -79,7 +79,7 @@ internal DeleteAsyncSearchRequestDescriptor()
 	}
 
 	internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchDelete;
-	internal override HttpMethod HttpMethod => HttpMethod.DELETE;
+	protected override HttpMethod StaticHttpMethod => HttpMethod.DELETE;
 	internal override bool SupportsBody => false;
 	public DeleteAsyncSearchRequestDescriptor Id(Elastic.Clients.Elasticsearch.Id id)
 	{

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

@@ -46,7 +46,7 @@ public GetAsyncSearchRequest(Elastic.Clients.Elasticsearch.Id id) : base(r => r.
 	}
 
 	internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchGet;
-	internal override HttpMethod HttpMethod => HttpMethod.GET;
+	protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
 	internal override bool SupportsBody => false;
 	[JsonIgnore]
 	public Elastic.Clients.Elasticsearch.Duration? KeepAlive { get => Q<Elastic.Clients.Elasticsearch.Duration?>("keep_alive"); set => Q("keep_alive", value); }
@@ -70,7 +70,7 @@ internal GetAsyncSearchRequestDescriptor()
 	}
 
 	internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchGet;
-	internal override HttpMethod HttpMethod => HttpMethod.GET;
+	protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
 	internal override bool SupportsBody => false;
 	public GetAsyncSearchRequestDescriptor<TDocument> KeepAlive(Elastic.Clients.Elasticsearch.Duration? keepAlive) => Qs("keep_alive", keepAlive);
 	public GetAsyncSearchRequestDescriptor<TDocument> TypedKeys(bool? typedKeys = true) => Qs("typed_keys", typedKeys);
@@ -98,7 +98,7 @@ internal GetAsyncSearchRequestDescriptor()
 	}
 
 	internal override ApiUrls ApiUrls => ApiUrlsLookups.AsyncSearchGet;
-	internal override HttpMethod HttpMethod => HttpMethod.GET;
+	protected override HttpMethod StaticHttpMethod => HttpMethod.GET;
 	internal override bool SupportsBody => false;
 	public GetAsyncSearchRequestDescriptor KeepAlive(Elastic.Clients.Elasticsearch.Duration? keepAlive) => Qs("keep_alive", keepAlive);
 	public GetAsyncSearchRequestDescriptor TypedKeys(bool? typedKeys = true) => Qs("typed_keys", typedKeys);