Update xml-docs to point to Elastic.Transport and generate docs

Mpdreamz · Mpdreamz · commit 5c030792f3b9 · 2020-10-06T10:05:16.000+02:00
diff --git a/docs/client-concepts/connection-pooling/building-blocks/request-pipelines.asciidoc b/docs/client-concepts/connection-pooling/building-blocks/request-pipelines.asciidoc
@@ -27,7 +27,9 @@ var pipeline = new RequestPipeline(
     settings,
     DateTimeProvider.Default,
     new RecyclableMemoryStreamFactory(),
-    new SearchRequestParameters());
+    new SearchRequestParameters(),
+    ElasticsearchProductRegistration.Default
+);
 
 pipeline.GetType().Should().Implement<IDisposable>();
 ----
@@ -42,7 +44,9 @@ var requestPipeline = requestPipelineFactory.Create(
     settings,
     DateTimeProvider.Default, <1>
     new RecyclableMemoryStreamFactory(),
-    new SearchRequestParameters());
+    new SearchRequestParameters(),
+    ElasticsearchProductRegistration.Default
+);
 
 requestPipeline.Should().BeOfType<RequestPipeline>();
 requestPipeline.GetType().Should().Implement<IDisposable>();
@@ -58,7 +62,9 @@ var transport = new Transport<IConnectionSettingsValues>(
     settings,
     requestPipelineFactory,
     DateTimeProvider.Default,
-    new RecyclableMemoryStreamFactory());
+    new RecyclableMemoryStreamFactory(),
+    ElasticsearchProductRegistration.Default
+);
 
 var client = new ElasticClient(transport);
 ----
diff --git a/docs/client-concepts/connection-pooling/building-blocks/transports.asciidoc b/docs/client-concepts/connection-pooling/building-blocks/transports.asciidoc
@@ -28,18 +28,18 @@ In the low level client, `ElasticLowLevelClient`, a `Transport` is instantiated
 
 [source,csharp]
 ----
-var lowLevelTransport = new Transport<ConnectionConfiguration>(new ConnectionConfiguration());
+var lowLevelTransport = new Transport<ConnectionConfiguration>(new ConnectionConfiguration(), ElasticsearchProductRegistration.Default);
 ----
 
 and in the high level client, `ElasticClient`, like this 
 
 [source,csharp]
 ----
-var highlevelTransport = new Transport<ConnectionSettings>(new ConnectionSettings());
+var highlevelTransport = new Transport<ConnectionSettings>(new ConnectionSettings(), ElasticsearchProductRegistration.Default);
 
 var connectionPool = new SingleNodeConnectionPool(new Uri("http://localhost:9200"));
 var inMemoryTransport = new Transport<ConnectionSettings>(
-    new ConnectionSettings(connectionPool, new InMemoryConnection()));
+    new ConnectionSettings(connectionPool, new InMemoryConnection()), ElasticsearchProductRegistration.Default);
 ----
 
 The only two methods on `ITransport` are `Request()` and `RequestAsync()`; the default `ITransport` implementation is responsible for introducing
diff --git a/docs/client-concepts/connection-pooling/exceptions/unexpected-exceptions.asciidoc b/docs/client-concepts/connection-pooling/exceptions/unexpected-exceptions.asciidoc
@@ -16,7 +16,7 @@ please modify the original csharp file found at the link and submit the PR with
 === Unexpected exceptions
 
 When a client call throws an exception that the `IConnection` cannot handle, the exception will bubble
-out of the client as an `UnexpectedElasticsearchClientException`, regardless of whether the client is configured to
+out of the client as an `UnexpectedTransportException`, regardless of whether the client is configured to
 throw exceptions or not.
 
 An `IConnection` is in charge of knowing which exceptions it can recover from and those it can't, and the default `IConnection`
@@ -41,13 +41,13 @@ var audit = new Auditor(() => VirtualClusterWith <1>
 
 audit = await audit.TraceCall(
     new ClientCall {
-        { AuditEvent.HealthyResponse, 9200 }, <3>
+        { HealthyResponse, 9200 }, <3>
     }
 );
 
 audit = await audit.TraceUnexpectedException(
     new ClientCall {
-        { AuditEvent.BadResponse, 9201 }, <4>
+        { BadResponse, 9201 }, <4>
     },
     (e) =>
     {
@@ -63,7 +63,7 @@ audit = await audit.TraceUnexpectedException(
 <4> ...but the second call, to 9201, returns a bad response
 
 Sometimes, an unexpected exception happens further down in the pipeline. In this scenario, we
-wrap them inside an `UnexpectedElasticsearchClientException` so that information about where
+wrap them inside an `UnexpectedTransportException` so that information about where
 in the pipeline the exception happened is not lost.
 
 In this next example, a call to 9200 fails with a `WebException`.
@@ -86,8 +86,8 @@ var audit = new Auditor(() => VirtualClusterWith
 
 audit = await audit.TraceUnexpectedException(
     new ClientCall {
-        { AuditEvent.BadResponse, 9200 },
-        { AuditEvent.BadResponse, 9201 }, <3>
+        { BadResponse, 9200 },
+        { BadResponse, 9201 }, <3>
     },
     (e) =>
     {
@@ -120,9 +120,9 @@ var audit = new Auditor(() => VirtualClusterWith
 
 audit = await audit.TraceUnexpectedException(
     new ClientCall {
-        { AuditEvent.PingFailure, 9200 },
-        { AuditEvent.PingSuccess, 9201 },
-        { AuditEvent.BadResponse, 9201 },
+        { PingFailure, 9200 },
+        { PingSuccess, 9201 },
+        { BadResponse, 9201 },
     },
     e =>
     {
@@ -136,7 +136,7 @@ audit = await audit.TraceUnexpectedException(
         pipelineException.FailureReason.Should().Be(PipelineFailure.PingFailure);
         pipelineException.InnerException.Message.Should().Be("ping exception");
 
-        var pingException = e.AuditTrail.First(a => a.Event == AuditEvent.PingFailure).Exception; <3>
+        var pingException = e.AuditTrail.First(a => a.Event == PingFailure).Exception; <3>
         pingException.Should().NotBeNull();
         pingException.Message.Should().Be("ping exception");
     }
diff --git a/docs/client-concepts/connection-pooling/exceptions/unrecoverable-exceptions.asciidoc b/docs/client-concepts/connection-pooling/exceptions/unrecoverable-exceptions.asciidoc
@@ -31,7 +31,7 @@ but by exiting the pipeline.
 
 --
 
-By default, the client won't throw on any `ElasticsearchClientException` but instead return an invalid response
+By default, the client won't throw on any `TransportException` but instead return an invalid response
 that can be detected by checking the `.IsValid` property on the response. You can change this behaviour with
 by using `ThrowExceptions()` on <<configuration-options, `ConnectionSettings`>>.
 
@@ -90,8 +90,8 @@ followed by a bad response as a result of the 401 bad authentication response
 ----
 audit = await audit.TraceElasticsearchException(
     new ClientCall {
-        { AuditEvent.PingSuccess, 9200 }, <1>
-        { AuditEvent.BadResponse, 9200 }, <2>
+        { PingSuccess, 9200 }, <1>
+        { BadResponse, 9200 }, <2>
     },
     exception =>
     {
@@ -123,8 +123,8 @@ var audit = new Auditor(() => VirtualClusterWith
 
 audit = await audit.TraceElasticsearchException(
     new ClientCall {
-        { AuditEvent.PingSuccess, 9200 },
-        { AuditEvent.BadResponse, 9201 },
+        { PingSuccess, 9200 },
+        { BadResponse, 9201 },
     },
     (e) =>
     {
@@ -154,8 +154,8 @@ var audit = new Auditor(() => VirtualClusterWith
 
 audit = await audit.TraceElasticsearchException(
     new ClientCall {
-        { AuditEvent.PingSuccess, 9200 },
-        { AuditEvent.BadResponse, 9200 },
+        { PingSuccess, 9200 },
+        { BadResponse, 9200 },
     },
     (e) =>
     {
diff --git a/docs/client-concepts/connection-pooling/failover/falling-over.asciidoc b/docs/client-concepts/connection-pooling/failover/falling-over.asciidoc
@@ -30,8 +30,8 @@ var audit = new Auditor(() => VirtualClusterWith
 
 audit = await audit.TraceCall(
     new ClientCall {
-        { AuditEvent.BadResponse, 9200 },
-        { AuditEvent.HealthyResponse, 9201 },
+        { BadResponse, 9200 },
+        { HealthyResponse, 9201 },
     }
 );
 ----
@@ -53,8 +53,8 @@ var audit = new Auditor(() => VirtualClusterWith
 
 audit = await audit.TraceCall(
     new ClientCall {
-        { AuditEvent.BadResponse, 9200 },
-        { AuditEvent.HealthyResponse, 9201 },
+        { BadResponse, 9200 },
+        { HealthyResponse, 9201 },
     }
 );
 ----
@@ -76,8 +76,8 @@ var audit = new Auditor(() => VirtualClusterWith
 
 audit = await audit.TraceCall(
     new ClientCall {
-        { AuditEvent.BadResponse, 9200 },
-        { AuditEvent.HealthyResponse, 9201 },
+        { BadResponse, 9200 },
+        { HealthyResponse, 9201 },
     }
 );
 ----
@@ -99,8 +99,8 @@ var audit = new Auditor(() => VirtualClusterWith
 
 audit = await audit.TraceCall(
     new ClientCall {
-        { AuditEvent.BadResponse, 9200 },
-        { AuditEvent.HealthyResponse, 9201 },
+        { BadResponse, 9200 },
+        { HealthyResponse, 9201 },
     }
 );
 ----
@@ -122,7 +122,7 @@ var audit = new Auditor(() => VirtualClusterWith
 
 audit = await audit.TraceCall(
     new ClientCall {
-        { AuditEvent.BadResponse, 9200 },
+        { BadResponse, 9200 },
     }
 );
 ----
diff --git a/docs/client-concepts/connection-pooling/sniffing/role-detection.asciidoc b/docs/client-concepts/connection-pooling/sniffing/role-detection.asciidoc
@@ -286,7 +286,7 @@ API call fails because the node predicate filters out all nodes as targets on wh
 
 [source,csharp]
 ----
-await audit.TraceUnexpectedElasticsearchException(new ClientCall
+await audit.TraceUnexpectedTransportException(new ClientCall
 {
     { SniffOnStartup }, <1>
     { SniffSuccess }, <2>
diff --git a/docs/client-concepts/connection-pooling/sticky/sticky-sniffing-connection-pool.asciidoc b/docs/client-concepts/connection-pooling/sticky/sticky-sniffing-connection-pool.asciidoc
@@ -24,7 +24,7 @@ the nodes a sniff returns.
 ----
 var numberOfNodes = 10;
 var uris = Enumerable.Range(9200, numberOfNodes).Select(p => new Uri("http://localhost:" + p));
-var pool = new Elasticsearch.Net.StickySniffingConnectionPool(uris, (n)=>0f);
+var pool = new Elastic.Transport.StickySniffingConnectionPool(uris, (n)=>0f);
 ----
 
 Here we have setup a sticky connection pool seeded with 10 nodes all weighted the same.
diff --git a/docs/client-concepts/connection/configuration-options.asciidoc b/docs/client-concepts/connection/configuration-options.asciidoc
@@ -60,7 +60,7 @@ Disables the automatic detection of a proxy
 
 `DisableDirectStreaming`::
 
-Ensures the response bytes are always available on the `ElasticsearchResponse<T>`
+Ensures the response bytes are always available on the `ITransportResponse`
 +
 IMPORTANT: Depending on the registered serializer, this may cause the response to be buffered in memory first, potentially affecting performance.
 
@@ -182,7 +182,7 @@ Whether the request should be sent with chunked Transfer-Encoding. Default is `f
 
 The user agent string to send with requests. Useful for debugging purposes to understand client and framework versions that initiate requests to Elasticsearch
 
-:xml-docs: Elasticsearch.Net:ConnectionConfiguration`1
+:xml-docs: Elastic.Transport:ConnectionConfiguration`1
 
 ==== ConnectionConfiguration with ElasticLowLevelClient
 
diff --git a/docs/client-concepts/high-level/serialization/custom-serialization.asciidoc b/docs/client-concepts/high-level/serialization/custom-serialization.asciidoc
@@ -59,7 +59,7 @@ Implementing `IElasticsearchSerializer` is technically enough to inject your own
 
 [source,csharp]
 ----
-public class VanillaSerializer : IElasticsearchSerializer
+public class VanillaSerializer : ITransportSerializer
 {
     public T Deserialize<T>(Stream stream) => throw new NotImplementedException();
 
@@ -166,7 +166,7 @@ and override the `CreateJsonSerializerSettings` and `ModifyContractResolver` met
 ----
 public class MyFirstCustomJsonNetSerializer : ConnectionSettingsAwareSerializerBase
 {
-    public MyFirstCustomJsonNetSerializer(IElasticsearchSerializer builtinSerializer, IConnectionSettingsValues connectionSettings)
+    public MyFirstCustomJsonNetSerializer(ITransportSerializer builtinSerializer, IConnectionSettingsValues connectionSettings)
         : base(builtinSerializer, connectionSettings) { }
 
     protected override JsonSerializerSettings CreateJsonSerializerSettings() =>
@@ -285,7 +285,7 @@ public class MySecondCustomContractResolver : ConnectionSettingsAwareContractRes
 
 public class MySecondCustomJsonNetSerializer : ConnectionSettingsAwareSerializerBase
 {
-    public MySecondCustomJsonNetSerializer(IElasticsearchSerializer builtinSerializer, IConnectionSettingsValues connectionSettings)
+    public MySecondCustomJsonNetSerializer(ITransportSerializer builtinSerializer, IConnectionSettingsValues connectionSettings)
         : base(builtinSerializer, connectionSettings) { }
 
     protected override JsonSerializerSettings CreateJsonSerializerSettings() =>
diff --git a/docs/client-concepts/troubleshooting/audit-trail.asciidoc b/docs/client-concepts/troubleshooting/audit-trail.asciidoc
@@ -70,10 +70,10 @@ But can also be accessed manually:
 [source,csharp]
 ----
 response.ApiCall.AuditTrail.Count.Should().Be(4, "{0}", debug);
-response.ApiCall.AuditTrail[0].Event.Should().Be(AuditEvent.SniffOnStartup, "{0}", debug);
-response.ApiCall.AuditTrail[1].Event.Should().Be(AuditEvent.SniffSuccess, "{0}", debug);
-response.ApiCall.AuditTrail[2].Event.Should().Be(AuditEvent.PingSuccess, "{0}", debug);
-response.ApiCall.AuditTrail[3].Event.Should().Be(AuditEvent.HealthyResponse, "{0}", debug);
+response.ApiCall.AuditTrail[0].Event.Should().Be(SniffOnStartup, "{0}", debug);
+response.ApiCall.AuditTrail[1].Event.Should().Be(SniffSuccess, "{0}", debug);
+response.ApiCall.AuditTrail[2].Event.Should().Be(PingSuccess, "{0}", debug);
+response.ApiCall.AuditTrail[3].Event.Should().Be(HealthyResponse, "{0}", debug);
 ----
 
 Each audit has a started and ended `DateTime` on it that will provide
diff --git a/docs/client-concepts/troubleshooting/logging-with-on-request-completed.asciidoc b/docs/client-concepts/troubleshooting/logging-with-on-request-completed.asciidoc
@@ -54,10 +54,10 @@ var client = FixedResponseClient.Create( <1>
         .OnRequestCompleted(r => counter++)
 );
 
-Assert.Throws<ElasticsearchClientException>(() => client.RootNodeInfo()); <3>
+Assert.Throws<TransportException>(() => client.RootNodeInfo()); <3>
 counter.Should().Be(1);
 
-await Assert.ThrowsAsync<ElasticsearchClientException>(async () => await client.RootNodeInfoAsync());
+await Assert.ThrowsAsync<TransportException>(async () => await client.RootNodeInfoAsync());
 counter.Should().Be(2);
 ----
 <1> Configure a client with a connection that **always returns a HTTP 500 response
diff --git a/docs/conventions.asciidoc b/docs/conventions.asciidoc
@@ -52,18 +52,18 @@ include::client-concepts/low-level/lifetimes.asciidoc[]
 
 There are three categories of exceptions that may be thrown:
 
-`ElasticsearchClientException`::
+`TransportException`::
 
 These are known exceptions, either an exception that occurred in the request pipeline
 (such as max retries or timeout reached, bad authentication, etc.) or Elasticsearch itself returned an error (could
 not parse the request, bad query, missing field, etc.). If it is an Elasticsearch error, the `ServerError` property
 on the response will contain the the actual error that was returned.  The inner exception will always contain the
 root causing exception.
 
-`UnexpectedElasticsearchClientException`::
+`UnexpectedTransportException`::
 
 These are unknown exceptions, for instance a response from Elasticsearch not
-properly deserialized.  These are sometimes bugs and {github}/issues[should be reported]. This exception also inherits from `ElasticsearchClientException`
+properly deserialized.  These are sometimes bugs and {github}/issues[should be reported]. This exception also inherits from `TransportException`
 so an additional catch block isn't necessary, but can be helpful in distinguishing between the two.
 
 Development time exceptions::
diff --git a/src/DocGenerator/AsciiDoc/GeneratedAsciidocVisitor.cs b/src/DocGenerator/AsciiDoc/GeneratedAsciidocVisitor.cs
@@ -11,6 +11,7 @@
 using System.Text.RegularExpressions;
 using AsciiDocNet;
 using DocGenerator.XmlDocs;
+using Elastic.Transport;
 using Elasticsearch.Net;
 using Microsoft.CodeAnalysis;
 using Nest;
@@ -266,6 +267,11 @@ string XmlFile(string project)
 					assembly = typeof(ElasticLowLevelClient).Assembly;
 					assemblyNamespace = typeof(ElasticLowLevelClient).Namespace;
 					break;
+				case "elastic.transport":
+					xmlDocsFile = Path.GetFullPath(XmlFile("Elastic.Transport"));
+					assembly = typeof(CloudConnectionPool).Assembly;
+					assemblyNamespace = typeof(CloudConnectionPool).Namespace;
+					break;
 				default:
 					xmlDocsFile = Path.GetFullPath(XmlFile("Nest"));
 					assembly = typeof(ElasticClient).Assembly;
diff --git a/tests/Tests/ClientConcepts/Connection/ConfigurationOptions.doc.cs b/tests/Tests/ClientConcepts/Connection/ConfigurationOptions.doc.cs
@@ -26,7 +26,7 @@ public class ConfigurationOptions
 		 * `ConnectionSettings` derives from `ConnectionConfiguration`, these options are available for both
 		 * the low level and high level client:
 		 *
-		 * :xml-docs: Elasticsearch.Net:ConnectionConfiguration`1
+		 * :xml-docs: Elastic.Transport:ConnectionConfiguration`1
 		 *
 		 * ==== ConnectionConfiguration with ElasticLowLevelClient
 		 *

Original file line number	Diff line number	Diff line change
`@@ -286,7 +286,7 @@ API call fails because the node predicate filters out all nodes as targets on wh`
`286`	`286`
`287`	`287`	`[source,csharp]`
`288`	`288`	`----`
`289`		`-await audit.TraceUnexpectedElasticsearchException(new ClientCall`
	`289`	`+await audit.TraceUnexpectedTransportException(new ClientCall`
`290`	`290`	`{`
`291`	`291`	`{ SniffOnStartup }, <1>`
`292`	`292`	`{ SniffSuccess }, <2>`