Required header X-Goog-Fieldmask missing in Routes API sample code

[NateWr]

Please make sure you have searched for information in the following guides.

• Search the issues already opened: https://github.com/GoogleCloudPlatform/google-cloud-node/issues
• Check our Troubleshooting guide: https://googlecloudplatform.github.io/google-cloud-node/#/docs/guides/troubleshooting
• Check our FAQ: https://googlecloudplatform.github.io/google-cloud-node/#/docs/guides/faq
• Check our libraries HOW-TO: https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md
• Check out our authentication guide: https://github.com/googleapis/google-auth-library-nodejs
• Check out handwritten samples for many of our APIs: https://github.com/GoogleCloudPlatform/nodejs-docs-samples

Documentation Request

When using the sample code for the Routes API, I received the following error message:

Error: 3 INVALID_ARGUMENT: FieldMask is a required parameter. See https://cloud.google.com/apis/docs/system-parameters on how to provide it. As an example, you can set the header 'X-Goog-FieldMask' to value 'routes.distanceMeters,routes.duration,routes.polyline.encodedPolyline' to ask for the route distance, duration, and polyline in the response. You can also set the value to '*' in manual testing to get all the available response fields. However, using the '*' wildcard is discouraged in production.

To fix this, I had to change the following line:

const response = await routingClient.computeRoutes(request);

I had to pass a X-Goog-Fieldmask header:

const response = await routingClient.computeRoutes(request, {otherArgs: {headers: {'X-Goog-Fieldmask': '*'}});

Should the documentation be updated to include the field mask? Or did I encounter an unusual edge case of some kind?