feat: add Api Version to header for apiary (#550)

* feat: add Api Version to header for apiary

package.json

@@ -43,7 +43,7 @@
   },
   "devDependencies": {
     "@babel/plugin-proposal-private-methods": "^7.18.6",
-    "@compodoc/compodoc": "^1.1.9",
+    "@compodoc/compodoc": "1.1.23",
     "@types/execa": "^0.9.0",
     "@types/extend": "^3.0.1",
     "@types/mocha": "^9.0.0",

src/api.ts

@@ -50,6 +50,7 @@ export interface GlobalOptions extends MethodOptions {
 }
 
 export interface MethodOptions extends GaxiosOptions {
+  apiVersion?: string;
   rootUrl?: string;
   http2?: boolean;
   userAgentDirectives?: UserAgentDirective[];

src/apirequest.ts

@@ -21,7 +21,7 @@ import * as extend from 'extend';
 
 import {APIRequestParams, BodyResponseCallback} from './api';
 import {isBrowser} from './isbrowser';
-import {SchemaParameters} from './schema';
+import {SchemaParameters, SchemaMethod} from './schema';
 import * as h2 from './http2';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
@@ -138,7 +138,7 @@ async function createAPIRequestAsync<T>(parameters: APIRequestParams) {
 
   // Grab headers from user provided options
   const headers = params.headers || {};
-  populateAPIHeader(headers);
+  populateAPIHeader(headers, options.apiVersion);
   delete params.headers;
 
   // Un-alias parameters that were modified due to conflicts with reserved names
@@ -390,13 +390,16 @@ class ProgressStream extends stream.Transform {
   }
 }
 
-function populateAPIHeader(headers: Headers) {
+function populateAPIHeader(headers: Headers, apiVersion: string | undefined) {
   // TODO: we should eventually think about adding browser support for this
   // populating the gl-web header (web support should also be added to
   // google-auth-library-nodejs).
   if (!isBrowser()) {
-    headers[
-      'x-goog-api-client'
-    ] = `gdcl/${pkg.version} gl-node/${process.versions.node}`;
+    headers['x-goog-api-client'] =
+      `gdcl/${pkg.version} gl-node/${process.versions.node}`;
+  }
+
+  if (apiVersion) {
+    headers['x-goog-api-version'] = apiVersion;
   }
 }

src/endpoint.ts

@@ -118,6 +118,7 @@ export class Endpoint implements Target, APIRequestContext {
         options: {
           url: schemaUrl.substring(1, schemaUrl.length - 1),
           method: method.httpMethod,
+          apiVersion: method.apiVersion,
         },
         params,
         requiredParams: method.parameterOrder || [],

src/schema.ts

@@ -107,6 +107,7 @@ export interface SchemaMethod {
   fragment: string;
   mediaUpload: {protocols: {simple: {path: string}}};
   supportsMediaDownload?: boolean;
+  apiVersion?: string;
 }
 
 export interface FragmentResponse {

test/test.apirequest.ts

@@ -287,6 +287,23 @@ describe('createAPIRequest', () => {
       scope.done();
     });
 
+    it('should populate x-goog-api-version', async () => {
+      const scope = nock(url)
+        .get('/')
+        .reply(function () {
+          assert.ok(/1234/.test(this.req.headers['x-goog-api-version'][0]));
+          return [200, ''];
+        });
+      await createAPIRequest<FakeParams>({
+        options: {url, apiVersion: '1234'},
+        params: {},
+        requiredParams: [],
+        pathParams: [],
+        context: fakeContext,
+      });
+      scope.done();
+    });
+
     it('should rewrite url to match default rootUrl', async () => {
       const rootUrl = 'http://www.googleapis.com/';
       const path = '/api/service';