Mostly doc updates, +remove support for method as string

[arvados.git] / lib / google / api_client / discovery / api.rb

diff --git a/lib/google/api_client/discovery/api.rb b/lib/google/api_client/discovery/api.rb
index 53d5ee6d146567a6a2a93168dc5c2a95d8fbaf38..6d9b07d2a004e6251da23966ef19d578c4c96e37 100644 (file)
--- a/lib/google/api_client/discovery/api.rb
+++ b/lib/google/api_client/discovery/api.rb
@@ -29,13 +29,9 @@ module Google
       ##
       # Creates a description of a particular version of a service.
       #
-      # @param [String] api
-      #   The identifier for the service.  Note that while this frequently
-      #   matches the first segment of all of the service's RPC names, this
-      #   should not be assumed.  There is no requirement that these match.
-      # @param [String] version
-      #   The identifier for the service version.
-      # @param [Hash] api_description
+      # @param [String] document_base
+      #   Base URI for the service
+      # @param [Hash] discovery_document
       #   The section of the discovery document that applies to this service
       #   version.
       #
@@ -159,7 +155,7 @@ module Google
       ##
       # Updates the hierarchy of resources and methods with the new base.
       #
-      # @param [Addressable::URI, #to_str, String] new_base
+      # @param [Addressable::URI, #to_str, String] new_method_base
       #   The new base URI to use for the service.
       def method_base=(new_method_base)
         @method_base = Addressable::URI.parse(new_method_base)
@@ -171,6 +167,21 @@ module Google
         end
       end
 
+      ##
+      # Returns the base URI for batch calls to this service.
+      #
+      # @return [Addressable::URI] The base URI that methods are joined to.
+      def batch_path
+        if @discovery_document['batchPath']
+          return @batch_path ||= (
+            self.document_base.join(Addressable::URI.parse('/' +
+                @discovery_document['batchPath']))
+          ).normalize
+        else
+          return nil
+        end
+      end
+
       ##
       # A list of schemas available for this version of the API.
       #