googleapis-common-protos-types 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de52a20fefd0f95b277373ead520337d1a3ce1c9bd2a00c9b68f8bb709ab3d5f
-  data.tar.gz: 07551dd51821580df8333c1ae04243402afb71a0654c1487c0e089ce838e5922
+  metadata.gz: 3dde28f3b8164c6fdb58d2d6c8cbb6282a13f57f2f4cab476750f959d045233c
+  data.tar.gz: 2f5cb1538c96b21fce7c670e8efb01832b68f34ccf075d0d80b1cb5a3b3f8db8
 SHA512:
-  metadata.gz: 23ef2d9703bd572bf88f022575f2b1032865b9c9b253a6bf35f5bf4de541d49a313964ed65369bfc68ec3e6362946de378506d023c2958db7c8efa81213de28e
-  data.tar.gz: b597f4c46cd368b6833531adc47bf1787609d3f5c4a9b51c82d4c0329b16d1990d28fa6f30ee4ec48d3e866188320629df033442cee213570514c5786e6c5e8a
+  metadata.gz: 78e3c21e90e11baa4ceded231c71f5ff07b29cd1cf1529d38cb29721c04dec8a4b7d2192e597ea54903b727ee137488d7e6f51be05d422e032eb7d5d1623d72c
+  data.tar.gz: 02b2eebb1e88a6a9c04f8b1398c06ce27575dbc52a84f7b2de9046422960c7ff2f5e1db93527f04407c71df423e5b34570281cbbc7a96d206456d0d70ed09d79

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release History
 
+### 1.16.0 (2024-09-11)
+
+#### Features
+
+* Added referenced types to Google::Api::FieldInfo 
+#### Documentation
+
+* Various improvements to reference documentation 
+
 ### 1.15.0 (2024-06-11)
 
 #### Features

data/lib/google/api/client_pb.rb

@@ -409,6 +409,13 @@ end
 #
 #   // The fully qualified name of the method, for which the options below apply.
 #   // This is used to find the method to apply the options.
+#   //
+#   // Example:
+#   //
+#   //    publishing:
+#   //      method_settings:
+#   //      - selector: google.storage.control.v2.StorageControl.CreateFolder
+#   //        # method settings for CreateFolder...
 #   string selector = 1;
 #
 #   // Describes settings to use for long-running operations when generating
@@ -417,17 +424,14 @@ end
 #   //
 #   // Example of a YAML configuration::
 #   //
-#   //  publishing:
-#   //    method_settings:
+#   //    publishing:
+#   //      method_settings:
 #   //      - selector: google.cloud.speech.v2.Speech.BatchRecognize
 #   //        long_running:
-#   //          initial_poll_delay:
-#   //            seconds: 60 # 1 minute
+#   //          initial_poll_delay: 60s # 1 minute
 #   //          poll_delay_multiplier: 1.5
-#   //          max_poll_delay:
-#   //            seconds: 360 # 6 minutes
-#   //          total_poll_timeout:
-#   //             seconds: 54000 # 90 minutes
+#   //          max_poll_delay: 360s # 6 minutes
+#   //          total_poll_timeout: 54000s # 90 minutes
 #   LongRunning long_running = 2;
 #
 #   // List of top-level fields of the request message, that should be
@@ -436,8 +440,8 @@ end
 #   //
 #   // Example of a YAML configuration:
 #   //
-#   //  publishing:
-#   //    method_settings:
+#   //    publishing:
+#   //      method_settings:
 #   //      - selector: google.example.v1.ExampleService.CreateExample
 #   //        auto_populated_fields:
 #   //        - request_id

data/lib/google/api/context_pb.rb

@@ -116,10 +116,12 @@ end
 #   // details.
 #   string selector = 1;
 #
-#   // A list of full type names of requested contexts.
+#   // A list of full type names of requested contexts, only the requested context
+#   // will be made available to the backend.
 #   repeated string requested = 2;
 #
-#   // A list of full type names of provided contexts.
+#   // A list of full type names of provided contexts. It is used to support
+#   // propagating HTTP headers and ETags from the response extension.
 #   repeated string provided = 3;
 #
 #   // A list of full type names or extension IDs of extensions allowed in grpc

data/lib/google/api/endpoint_pb.rb

@@ -5,7 +5,7 @@
 require 'google/protobuf'
 
 
-descriptor_data = "\n\x19google/api/endpoint.proto\x12\ngoogle.api\"Q\n\x08\x45ndpoint\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x13\n\x07\x61liases\x18\x02 \x03(\tB\x02\x18\x01\x12\x0e\n\x06target\x18\x65 \x01(\t\x12\x12\n\nallow_cors\x18\x05 \x01(\x08\x42o\n\x0e\x63om.google.apiB\rEndpointProtoP\x01ZEgoogle.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig\xa2\x02\x04GAPIb\x06proto3"
+descriptor_data = "\n\x19google/api/endpoint.proto\x12\ngoogle.api\"M\n\x08\x45ndpoint\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x0f\n\x07\x61liases\x18\x02 \x03(\t\x12\x0e\n\x06target\x18\x65 \x01(\t\x12\x12\n\nallow_cors\x18\x05 \x01(\x08\x42o\n\x0e\x63om.google.apiB\rEndpointProtoP\x01ZEgoogle.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig\xa2\x02\x04GAPIb\x06proto3"
 
 pool = Google::Protobuf::DescriptorPool.generated_pool
 
@@ -88,14 +88,10 @@ end
 #   // The canonical name of this endpoint.
 #   string name = 1;
 #
-#   // Unimplemented. Dot not use.
-#   //
-#   // DEPRECATED: This field is no longer supported. Instead of using aliases,
-#   // please specify multiple [google.api.Endpoint][google.api.Endpoint] for each
-#   // of the intended aliases.
-#   //
-#   // Additional names that this endpoint will be hosted on.
-#   repeated string aliases = 2 [deprecated = true];
+#   // Aliases for this endpoint, these will be served by the same UrlMap as the
+#   // parent endpoint, and will be provisioned in the GCP stack for the Regional
+#   // Endpoints.
+#   repeated string aliases = 2;
 #
 #   // The specification of an Internet routable address of API frontend that will
 #   // handle requests to this [API

data/lib/google/api/field_info_pb.rb

@@ -7,7 +7,7 @@ require 'google/protobuf'
 require 'google/protobuf/descriptor_pb'
 
 
-descriptor_data = "\n\x1bgoogle/api/field_info.proto\x12\ngoogle.api\x1a google/protobuf/descriptor.proto\"\x8c\x01\n\tFieldInfo\x12,\n\x06\x66ormat\x18\x01 \x01(\x0e\x32\x1c.google.api.FieldInfo.Format\"Q\n\x06\x46ormat\x12\x16\n\x12\x46ORMAT_UNSPECIFIED\x10\x00\x12\t\n\x05UUID4\x10\x01\x12\x08\n\x04IPV4\x10\x02\x12\x08\n\x04IPV6\x10\x03\x12\x10\n\x0cIPV4_OR_IPV6\x10\x04:L\n\nfield_info\x12\x1d.google.protobuf.FieldOptions\x18\xcc\xf1\xf9\x8a\x01 \x01(\x0b\x32\x15.google.api.FieldInfoBl\n\x0e\x63om.google.apiB\x0e\x46ieldInfoProtoP\x01ZAgoogle.golang.org/genproto/googleapis/api/annotations;annotations\xa2\x02\x04GAPIb\x06proto3"
+descriptor_data = "\n\x1bgoogle/api/field_info.proto\x12\ngoogle.api\x1a google/protobuf/descriptor.proto\"\xc1\x01\n\tFieldInfo\x12,\n\x06\x66ormat\x18\x01 \x01(\x0e\x32\x1c.google.api.FieldInfo.Format\x12\x33\n\x10referenced_types\x18\x02 \x03(\x0b\x32\x19.google.api.TypeReference\"Q\n\x06\x46ormat\x12\x16\n\x12\x46ORMAT_UNSPECIFIED\x10\x00\x12\t\n\x05UUID4\x10\x01\x12\x08\n\x04IPV4\x10\x02\x12\x08\n\x04IPV6\x10\x03\x12\x10\n\x0cIPV4_OR_IPV6\x10\x04\"\"\n\rTypeReference\x12\x11\n\ttype_name\x18\x01 \x01(\t:L\n\nfield_info\x12\x1d.google.protobuf.FieldOptions\x18\xcc\xf1\xf9\x8a\x01 \x01(\x0b\x32\x15.google.api.FieldInfoBl\n\x0e\x63om.google.apiB\x0e\x46ieldInfoProtoP\x01ZAgoogle.golang.org/genproto/googleapis/api/annotations;annotations\xa2\x02\x04GAPIb\x06proto3"
 
 pool = Google::Protobuf::DescriptorPool.generated_pool
 
@@ -37,6 +37,7 @@ module Google
   module Api
     FieldInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.FieldInfo").msgclass
     FieldInfo::Format = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.FieldInfo.Format").enummodule
+    TypeReference = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.api.TypeReference").msgclass
   end
 end
 
@@ -73,12 +74,19 @@ end
 #   //
 #   // Examples:
 #   //
-#   //   string request_id = 1 [(google.api.field_info).format = UUID4];
-#   //   string old_ip_address = 2 [(google.api.field_info).format = IPV4];
-#   //   string new_ip_address = 3 [(google.api.field_info).format = IPV6];
-#   //   string actual_ip_address = 4 [
-#   //     (google.api.field_info).format = IPV4_OR_IPV6
-#   //   ];
+#   //     string request_id = 1 [(google.api.field_info).format = UUID4];
+#   //     string old_ip_address = 2 [(google.api.field_info).format = IPV4];
+#   //     string new_ip_address = 3 [(google.api.field_info).format = IPV6];
+#   //     string actual_ip_address = 4 [
+#   //       (google.api.field_info).format = IPV4_OR_IPV6
+#   //     ];
+#   //     google.protobuf.Any generic_field = 5 [
+#   //       (google.api.field_info).referenced_types = {type_name: "ActualType"},
+#   //       (google.api.field_info).referenced_types = {type_name: "OtherType"},
+#   //     ];
+#   //     google.protobuf.Any generic_user_input = 5 [
+#   //       (google.api.field_info).referenced_types = {type_name: "*"},
+#   //     ];
 #   google.api.FieldInfo field_info = 291403980;
 # }
 #
@@ -120,4 +128,24 @@ end
 #   // any API consumer, just documents the API's format for the field it is
 #   // applied to.
 #   Format format = 1;
+#
+#   // The type(s) that the annotated, generic field may represent.
+#   //
+#   // Currently, this must only be used on fields of type `google.protobuf.Any`.
+#   // Supporting other generic types may be considered in the future.
+#   repeated TypeReference referenced_types = 2;
+# }
+#
+# // A reference to a message type, for use in [FieldInfo][google.api.FieldInfo].
+# message TypeReference {
+#   // The name of the type that the annotated, generic field may represent.
+#   // If the type is in the same protobuf package, the value can be the simple
+#   // message name e.g., `"MyMessage"`. Otherwise, the value must be the
+#   // fully-qualified message name e.g., `"google.library.v1.Book"`.
+#   //
+#   // If the type(s) are unknown to the service (e.g. the field accepts generic
+#   // user input), use the wildcard `"*"` to denote this behavior.
+#   //
+#   // See [AIP-202](https://google.aip.dev/202#type-references) for more details.
+#   string type_name = 1;
 # }

data/lib/google/api/http_pb.rb

@@ -84,7 +84,7 @@ end
 #   bool fully_decode_reserved_expansion = 2;
 # }
 #
-# // # gRPC Transcoding
+# // gRPC Transcoding
 # //
 # // gRPC Transcoding is a feature for mapping between a gRPC method and one or
 # // more HTTP REST endpoints. It allows developers to build a single API service
@@ -125,9 +125,8 @@ end
 # //
 # // This enables an HTTP REST to gRPC mapping as below:
 # //
-# // HTTP | gRPC
-# // -----|-----
-# // `GET /v1/messages/123456`  | `GetMessage(name: "messages/123456")`
+# // - HTTP: `GET /v1/messages/123456`
+# // - gRPC: `GetMessage(name: "messages/123456")`
 # //
 # // Any fields in the request message which are not bound by the path template
 # // automatically become HTTP query parameters if there is no HTTP request body.
@@ -151,11 +150,9 @@ end
 # //
 # // This enables a HTTP JSON to RPC mapping as below:
 # //
-# // HTTP | gRPC
-# // -----|-----
-# // `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
-# // `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield:
-# // "foo"))`
+# // - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo`
+# // - gRPC: `GetMessage(message_id: "123456" revision: 2 sub:
+# // SubMessage(subfield: "foo"))`
 # //
 # // Note that fields which are mapped to URL query parameters must have a
 # // primitive type or a repeated primitive type or a non-repeated message type.
@@ -185,10 +182,8 @@ end
 # // representation of the JSON in the request body is determined by
 # // protos JSON encoding:
 # //
-# // HTTP | gRPC
-# // -----|-----
-# // `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
-# // "123456" message { text: "Hi!" })`
+# // - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }`
+# // - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })`
 # //
 # // The special name `*` can be used in the body mapping to define that
 # // every field not bound by the path template should be mapped to the
@@ -211,10 +206,8 @@ end
 # //
 # // The following HTTP JSON to RPC mapping is enabled:
 # //
-# // HTTP | gRPC
-# // -----|-----
-# // `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
-# // "123456" text: "Hi!")`
+# // - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }`
+# // - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")`
 # //
 # // Note that when using `*` in the body mapping, it is not possible to
 # // have HTTP parameters, as all fields not bound by the path end in
@@ -242,13 +235,13 @@ end
 # //
 # // This enables the following two alternative HTTP JSON to RPC mappings:
 # //
-# // HTTP | gRPC
-# // -----|-----
-# // `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
-# // `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:
-# // "123456")`
+# // - HTTP: `GET /v1/messages/123456`
+# // - gRPC: `GetMessage(message_id: "123456")`
 # //
-# // ## Rules for HTTP mapping
+# // - HTTP: `GET /v1/users/me/messages/123456`
+# // - gRPC: `GetMessage(user_id: "me" message_id: "123456")`
+# //
+# // Rules for HTTP mapping
 # //
 # // 1. Leaf request fields (recursive expansion nested messages in the request
 # //    message) are classified into three categories:
@@ -267,7 +260,7 @@ end
 # //  request body, all
 # //     fields are passed via URL path and URL query parameters.
 # //
-# // ### Path template syntax
+# // Path template syntax
 # //
 # //     Template = "/" Segments [ Verb ] ;
 # //     Segments = Segment { "/" Segment } ;
@@ -306,7 +299,7 @@ end
 # // Document](https://developers.google.com/discovery/v1/reference/apis) as
 # // `{+var}`.
 # //
-# // ## Using gRPC API Service Configuration
+# // Using gRPC API Service Configuration
 # //
 # // gRPC API Service Configuration (service config) is a configuration language
 # // for configuring a gRPC service to become a user-facing product. The
@@ -321,15 +314,14 @@ end
 # // specified in the service config will override any matching transcoding
 # // configuration in the proto.
 # //
-# // Example:
+# // The following example selects a gRPC method and applies an `HttpRule` to it:
 # //
 # //     http:
 # //       rules:
-# //         # Selects a gRPC method and applies HttpRule to it.
 # //         - selector: example.v1.Messaging.GetMessage
 # //           get: /v1/messages/{message_id}/{sub.subfield}
 # //
-# // ## Special notes
+# // Special notes
 # //
 # // When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the
 # // proto to JSON conversion must follow the [proto3

data/lib/google/api/resource_pb.rb

@@ -225,8 +225,13 @@ end
 #
 #   // The plural name used in the resource name and permission names, such as
 #   // 'projects' for the resource name of 'projects/{project}' and the permission
-#   // name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
-#   // concept of the `plural` field in k8s CRD spec
+#   // name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception
+#   // to this is for Nested Collections that have stuttering names, as defined
+#   // in [AIP-122](https://google.aip.dev/122#nested-collections), where the
+#   // collection ID in the resource name pattern does not necessarily directly
+#   // match the `plural` value.
+#   //
+#   // It is the same concept of the `plural` field in k8s CRD spec
 #   // https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
 #   //
 #   // Note: The plural form is required even for singleton resources. See

data/lib/googleapis/common/protos/types/version.rb

@@ -17,7 +17,7 @@
 module Google
   module CommonProtos
     module Types
-      VERSION = "1.15.0".freeze
+      VERSION = "1.16.0".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: googleapis-common-protos-types
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.16.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-11 00:00:00.000000000 Z
+date: 2024-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf