fix: add api_version breadcrumb to client docs (#862)

Author: noahdietz

generator/gapic-generator-typescript/baselines/disable-packing-test-esm/esm/src/v1beta1/echo_client.ts.baseline

@@ -55,6 +55,8 @@ const version = getJSON(
  *  to have the values echoed in the response trailers. Set the
  *  'x-goog-request-params' metadata key on any method to have the values
  *  echoed in the response headers.
+ *
+ *  This client uses Echo version v1_20240408.
  * @class
  * @memberof v1beta1
  */

generator/gapic-generator-typescript/baselines/disable-packing-test/src/v1beta1/echo_client.ts.baseline

@@ -40,6 +40,8 @@ const version = require('../../../package.json').version;
  *  to have the values echoed in the response trailers. Set the
  *  'x-goog-request-params' metadata key on any method to have the values
  *  echoed in the response headers.
+ *
+ *  This client uses Echo version v1_20240408.
  * @class
  * @memberof v1beta1
  */

generator/gapic-generator-typescript/baselines/showcase-esm/esm/src/v1beta1/echo_client.ts.baseline

@@ -55,6 +55,8 @@ const version = getJSON(
  *  to have the values echoed in the response trailers. Set the
  *  'x-goog-request-params' metadata key on any method to have the values
  *  echoed in the response headers.
+ *
+ *  This client uses Echo version v1_20240408.
  * @class
  * @memberof v1beta1
  */

generator/gapic-generator-typescript/baselines/showcase-legacy-esm/esm/src/v1beta1/echo_client.ts.baseline

@@ -52,6 +52,8 @@ const version = getJSON(
  *  to have the values echoed in the response trailers. Set the
  *  'x-goog-request-params' metadata key on any method to have the values
  *  echoed in the response headers.
+ *
+ *  This client uses Echo version v1_20240408.
  * @class
  * @memberof v1beta1
  */

generator/gapic-generator-typescript/baselines/showcase-legacy/src/v1beta1/echo_client.ts.baseline

@@ -39,6 +39,8 @@ const version = require('../../../package.json').version;
  *  to have the values echoed in the response trailers. Set the
  *  'x-goog-request-params' metadata key on any method to have the values
  *  echoed in the response headers.
+ *
+ *  This client uses Echo version v1_20240408.
  * @class
  * @memberof v1beta1
  */

generator/gapic-generator-typescript/baselines/showcase/src/v1beta1/echo_client.ts.baseline

@@ -40,6 +40,8 @@ const version = require('../../../package.json').version;
  *  to have the values echoed in the response trailers. Set the
  *  'x-goog-request-params' metadata key on any method to have the values
  *  echoed in the response headers.
+ *
+ *  This client uses Echo version v1_20240408.
  * @class
  * @memberof v1beta1
  */

generator/gapic-generator-typescript/typescript/src/schema/proto.ts

@@ -1089,6 +1089,13 @@ export function augmentService(parameters: AugmentServiceParameters) {
   if (augmentedService.options?.['.google.api.apiVersion']) {
     augmentedService.apiVersion =
       augmentedService.options['.google.api.apiVersion'];
+
+    // Include google.api.api_version breadcrumb in client documentation for reference in other API artifacts.
+    // Include a line break to make it stand out from the service description.
+    augmentedService.comments.push('');
+    augmentedService.comments.push(
+      ` This client uses ${augmentedService.name} version ${augmentedService.apiVersion}.`,
+    );
   }
 
   // Build a list of resources referenced by this service