feat: Introduce google.api.api_version option to generated clients

gapic-generator/lib/gapic/presenters/service_presenter.rb

@@ -251,6 +251,11 @@ def generic_endpoint?
         gem.generic_endpoint?
       end
 
+      # @return [String] The api_version for this service, or empty if not defined.
+      def api_version
+        @service.api_version.nil? ? "" : @service.api_version
+      end
+
       def client_scopes
         scopes = Array(common_service_delegate&.client_scopes)
         return scopes unless scopes.empty?

gapic-generator/lib/gapic/presenters/service_rest_presenter.rb

@@ -381,6 +381,11 @@ def is_deprecated?
         @main_service.is_deprecated?
       end
 
+      # @return [String] The api_version for this service, or empty if not defined.
+      def api_version
+        @main_service.api_version.nil? ? "" : @main_service.api_version
+      end
+
       private
 
       # @return [Gapic::Presenters::ServicePresenter]

gapic-generator/lib/gapic/schema/wrappers.rb

@@ -288,7 +288,8 @@ def initialize descriptor, address, docs, methods
 
       OPTION_EXTENSION_NAMES = {
         "google.api.default_host" => [1049, :string],
-        "google.api.oauth_scopes" => [1050, :string]
+        "google.api.oauth_scopes" => [1050, :string],
+        "google.api.api_version" => [525_000_001, :string]
       }.freeze
 
       ##
@@ -310,6 +311,11 @@ def scopes
         String(option_named("google.api.oauth_scopes")).split ","
       end
 
+      # @return [String] The API version for this service.
+      def api_version
+        option_named "google.api.api_version"
+      end
+
       # @return [String] Ruby Package
       def ruby_package
         return nil if parent.nil?

gapic-generator/templates/default/service/client/_client.erb

@@ -21,6 +21,9 @@ require "securerandom"
 #
 <%- end -%>
 class <%= service.client_name %>
+  # @private
+  API_VERSION = "<%= service.api_version %>".freeze
+
   # @private
   DEFAULT_ENDPOINT_TEMPLATE = <%= service.client_endpoint_template.inspect %>
 

gapic-generator/templates/default/service/client/_operations.erb

@@ -5,6 +5,9 @@ require "<%= service.lro_service.proto_service_require %>"
 <% end %>
 # Service that implements Longrunning Operations API.
 class <%= service.operations_name %>
+  # @private
+  API_VERSION = "<%= service.api_version %>".freeze
+
   # @private
   DEFAULT_ENDPOINT_TEMPLATE = <%= service.client_endpoint_template.inspect %>
 

gapic-generator/templates/default/service/client/method/def/_options_defaults.erb

@@ -5,10 +5,11 @@ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
 # Customize the options with defaults
 metadata = @config.rpcs.<%= method.name %>.metadata.to_h
 
-# Set x-goog-api-client and x-goog-user-project headers
+# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
 metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
   lib_name: @config.lib_name, lib_version: @config.lib_version,
   gapic_version: ::<%= method.service.gem.version_name_full %>
+metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 <%- if method.routing_params? && !method.client_streaming? -%>
 

gapic-generator/templates/default/service/rest/client/_client.erb

@@ -22,6 +22,9 @@ require "securerandom"
 #
 <%- end -%>
 class <%= service.rest.client_name %>
+  # @private
+  API_VERSION = "<%= service.api_version %>".freeze
+
   # @private
   DEFAULT_ENDPOINT_TEMPLATE = <%= service.client_endpoint_template.inspect %>
 

gapic-generator/templates/default/service/rest/client/_operations.erb

@@ -4,6 +4,9 @@ require "gapic/operation"
 <% end %>
 # Service that implements Longrunning Operations API.
 class <%= service.operations_name %>
+  # @private
+  API_VERSION = "<%= service.api_version %>".freeze
+
   # @private
   DEFAULT_ENDPOINT_TEMPLATE = <%= service.client_endpoint_template.inspect %>
 

gapic-generator/templates/default/service/rest/client/method/def/_options_defaults.erb

@@ -5,12 +5,13 @@ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
 # Customize the options with defaults
 call_metadata = @config.rpcs.<%= method.name %>.metadata.to_h
 
-# Set x-goog-api-client and x-goog-user-project headers
+# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
   lib_name: @config.lib_name, lib_version: @config.lib_version,
   gapic_version: ::<%= method.service.gem.version_name_full %>,
   transports_version_send: [:rest]
 
+call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
 options.apply_defaults timeout:      @config.rpcs.<%= method.name %>.timeout,
@@ -19,4 +20,4 @@ options.apply_defaults timeout:      @config.rpcs.<%= method.name %>.timeout,
 
 options.apply_defaults timeout:      @config.timeout,
                        metadata:     @config.metadata,
-                       retry_policy: @config.retry_policy
+                       retry_policy: @config.retry_policy

shared/output/ads/googleads/lib/google/ads/google_ads/v15/services/campaign_service/client.rb

@@ -31,6 +31,9 @@ module CampaignService
             # Service to manage campaigns.
             #
             class Client
+              # @private
+              API_VERSION = ""
+
               # @private
               DEFAULT_ENDPOINT_TEMPLATE = "googleads.$UNIVERSE_DOMAIN$"
 
@@ -260,10 +263,11 @@ def mutate_campaigns request, options = nil
                 # Customize the options with defaults
                 metadata = @config.rpcs.mutate_campaigns.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Ads::GoogleAds::VERSION
+                metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 header_params = {}

shared/output/cloud/compute_small/lib/google/cloud/compute/v1/addresses/rest/client.rb

@@ -33,6 +33,9 @@ module Rest
             # The Addresses API.
             #
             class Client
+              # @private
+              API_VERSION = ""
+
               # @private
               DEFAULT_ENDPOINT_TEMPLATE = "compute.$UNIVERSE_DOMAIN$"
 
@@ -242,12 +245,13 @@ def aggregated_list request, options = nil
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.aggregated_list.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::Compute::V1::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.aggregated_list.timeout,
@@ -331,12 +335,13 @@ def delete request, options = nil
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.delete.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::Compute::V1::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.delete.timeout,
@@ -422,12 +427,13 @@ def get request, options = nil
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.get.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::Compute::V1::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.get.timeout,
@@ -510,12 +516,13 @@ def insert request, options = nil
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.insert.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::Compute::V1::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.insert.timeout,
@@ -619,12 +626,13 @@ def list request, options = nil
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.list.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::Compute::V1::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.list.timeout,

shared/output/cloud/compute_small/lib/google/cloud/compute/v1/global_operations/rest/client.rb

@@ -32,6 +32,9 @@ module Rest
             # The GlobalOperations API.
             #
             class Client
+              # @private
+              API_VERSION = ""
+
               # @private
               DEFAULT_ENDPOINT_TEMPLATE = "compute.$UNIVERSE_DOMAIN$"
 
@@ -207,12 +210,13 @@ def delete request, options = nil
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.delete.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::Compute::V1::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.delete.timeout,
@@ -287,12 +291,13 @@ def get request, options = nil
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.get.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::Compute::V1::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.get.timeout,

shared/output/cloud/compute_small/lib/google/cloud/compute/v1/networks/rest/client.rb

@@ -33,6 +33,9 @@ module Rest
             # The Networks API.
             #
             class Client
+              # @private
+              API_VERSION = ""
+
               # @private
               DEFAULT_ENDPOINT_TEMPLATE = "compute.$UNIVERSE_DOMAIN$"
 
@@ -248,12 +251,13 @@ def list_peering_routes request, options = nil
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.list_peering_routes.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::Compute::V1::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.list_peering_routes.timeout,
@@ -337,12 +341,13 @@ def remove_peering request, options = nil
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.remove_peering.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::Compute::V1::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.remove_peering.timeout,

shared/output/cloud/compute_small/lib/google/cloud/compute/v1/region_instance_group_managers/rest/client.rb

@@ -33,6 +33,9 @@ module Rest
             # The RegionInstanceGroupManagers API.
             #
             class Client
+              # @private
+              API_VERSION = ""
+
               # @private
               DEFAULT_ENDPOINT_TEMPLATE = "compute.$UNIVERSE_DOMAIN$"
 
@@ -236,12 +239,13 @@ def resize request, options = nil
                 # Customize the options with defaults
                 call_metadata = @config.rpcs.resize.metadata.to_h
 
-                # Set x-goog-api-client and x-goog-user-project headers
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
                 call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
                   lib_name: @config.lib_name, lib_version: @config.lib_version,
                   gapic_version: ::Google::Cloud::Compute::V1::VERSION,
                   transports_version_send: [:rest]
 
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
                 call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
                 options.apply_defaults timeout:      @config.rpcs.resize.timeout,