docs: Use rst syntax in readme (#157)

* docs: Use rst syntax in readme The readme file currently uses markdown syntax, but the file itself is a restructuredText file. I changed the syntax to rst. Alternatively we can rename the file to .md. Let me know if that's preferred. * clarify that the source of truth is googleapis/googleapis * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * Remove unused line in owlbot.py * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Anthonios Partheniou <[email protected]> Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Mar 20, 2023 · cf37c81 · cf37c81
1 parent ba17e49
commit cf37c81
Show file tree

Hide file tree

Showing 34 changed files with 206 additions and 118 deletions.
diff --git a/packages/googleapis-common-protos/README.rst b/packages/googleapis-common-protos/README.rst
@@ -1,8 +1,9 @@
+Google APIs common protos
+-------------------------
 
-# Google APIs common protos
-
-[![pypi](https://img.shields.io/pypi/v/googleapis-common-protos.svg)](https://pypi.org/project/googleapis-common-protos/)
+.. image:: https://img.shields.io/pypi/v/googleapis-common-protos.svg
+    :target: https://pypi.org/project/googleapis-common-protos/
 
 
 googleapis-common-protos contains the python classes generated from the common
-protos in the [googleapis/api-common-protos](https://github.com/googleapis/api-common-protos) repository.
+protos in the `googleapis/googleapis <https://github.com/googleapis/googleapis>`_ repository.
diff --git a/packages/googleapis-common-protos/google/api/auth.proto b/packages/googleapis-common-protos/google/api/auth.proto
@@ -1,4 +1,4 @@
-// Copyright 2015 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -62,7 +62,8 @@ message Authentication {
 message AuthenticationRule {
   // Selects the methods to which this rule applies.
   //
-  // Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
+  // Refer to [selector][google.api.DocumentationRule.selector] for syntax
+  // details.
   string selector = 1;
 
   // The requirements for OAuth credentials.

diff --git a/packages/googleapis-common-protos/google/api/backend.proto b/packages/googleapis-common-protos/google/api/backend.proto
@@ -1,4 +1,4 @@
-// Copyright 2015 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -91,7 +91,8 @@ message BackendRule {
 
   // Selects the methods to which this rule applies.
   //
-  // Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
+  // Refer to [selector][google.api.DocumentationRule.selector] for syntax
+  // details.
   string selector = 1;
 
   // The address of the API backend.
@@ -178,4 +179,7 @@ message BackendRule {
   // https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
   // for more details on the supported values.
   string protocol = 9;
+
+  // The map between request protocol and the backend address.
+  map<string, BackendRule> overrides_by_request_protocol = 10;
 }
diff --git a/packages/googleapis-common-protos/google/api/backend_pb2.py b/packages/googleapis-common-protos/google/api/backend_pb2.py
@@ -29,12 +29,15 @@
 
 
 DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
-    b'\n\x18google/api/backend.proto\x12\ngoogle.api"1\n\x07\x42\x61\x63kend\x12&\n\x05rules\x18\x01 \x03(\x0b\x32\x17.google.api.BackendRule"\xf6\x02\n\x0b\x42\x61\x63kendRule\x12\x10\n\x08selector\x18\x01 \x01(\t\x12\x0f\n\x07\x61\x64\x64ress\x18\x02 \x01(\t\x12\x10\n\x08\x64\x65\x61\x64line\x18\x03 \x01(\x01\x12\x18\n\x0cmin_deadline\x18\x04 \x01(\x01\x42\x02\x18\x01\x12\x1a\n\x12operation_deadline\x18\x05 \x01(\x01\x12\x41\n\x10path_translation\x18\x06 \x01(\x0e\x32\'.google.api.BackendRule.PathTranslation\x12\x16\n\x0cjwt_audience\x18\x07 \x01(\tH\x00\x12\x16\n\x0c\x64isable_auth\x18\x08 \x01(\x08H\x00\x12\x10\n\x08protocol\x18\t \x01(\t"e\n\x0fPathTranslation\x12 \n\x1cPATH_TRANSLATION_UNSPECIFIED\x10\x00\x12\x14\n\x10\x43ONSTANT_ADDRESS\x10\x01\x12\x1a\n\x16\x41PPEND_PATH_TO_ADDRESS\x10\x02\x42\x10\n\x0e\x61uthenticationBn\n\x0e\x63om.google.apiB\x0c\x42\x61\x63kendProtoP\x01ZEgoogle.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig\xa2\x02\x04GAPIb\x06proto3'
+    b'\n\x18google/api/backend.proto\x12\ngoogle.api"1\n\x07\x42\x61\x63kend\x12&\n\x05rules\x18\x01 \x03(\x0b\x32\x17.google.api.BackendRule"\xb2\x04\n\x0b\x42\x61\x63kendRule\x12\x10\n\x08selector\x18\x01 \x01(\t\x12\x0f\n\x07\x61\x64\x64ress\x18\x02 \x01(\t\x12\x10\n\x08\x64\x65\x61\x64line\x18\x03 \x01(\x01\x12\x18\n\x0cmin_deadline\x18\x04 \x01(\x01\x42\x02\x18\x01\x12\x1a\n\x12operation_deadline\x18\x05 \x01(\x01\x12\x41\n\x10path_translation\x18\x06 \x01(\x0e\x32\'.google.api.BackendRule.PathTranslation\x12\x16\n\x0cjwt_audience\x18\x07 \x01(\tH\x00\x12\x16\n\x0c\x64isable_auth\x18\x08 \x01(\x08H\x00\x12\x10\n\x08protocol\x18\t \x01(\t\x12^\n\x1doverrides_by_request_protocol\x18\n \x03(\x0b\x32\x37.google.api.BackendRule.OverridesByRequestProtocolEntry\x1aZ\n\x1fOverridesByRequestProtocolEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12&\n\x05value\x18\x02 \x01(\x0b\x32\x17.google.api.BackendRule:\x02\x38\x01"e\n\x0fPathTranslation\x12 \n\x1cPATH_TRANSLATION_UNSPECIFIED\x10\x00\x12\x14\n\x10\x43ONSTANT_ADDRESS\x10\x01\x12\x1a\n\x16\x41PPEND_PATH_TO_ADDRESS\x10\x02\x42\x10\n\x0e\x61uthenticationBn\n\x0e\x63om.google.apiB\x0c\x42\x61\x63kendProtoP\x01ZEgoogle.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig\xa2\x02\x04GAPIb\x06proto3'
 )
 
 
 _BACKEND = DESCRIPTOR.message_types_by_name["Backend"]
 _BACKENDRULE = DESCRIPTOR.message_types_by_name["BackendRule"]
+_BACKENDRULE_OVERRIDESBYREQUESTPROTOCOLENTRY = _BACKENDRULE.nested_types_by_name[
+    "OverridesByRequestProtocolEntry"
+]
 _BACKENDRULE_PATHTRANSLATION = _BACKENDRULE.enum_types_by_name["PathTranslation"]
 Backend = _reflection.GeneratedProtocolMessageType(
     "Backend",
@@ -51,23 +54,37 @@
     "BackendRule",
     (_message.Message,),
     {
+        "OverridesByRequestProtocolEntry": _reflection.GeneratedProtocolMessageType(
+            "OverridesByRequestProtocolEntry",
+            (_message.Message,),
+            {
+                "DESCRIPTOR": _BACKENDRULE_OVERRIDESBYREQUESTPROTOCOLENTRY,
+                "__module__": "google.api.backend_pb2"
+                # @@protoc_insertion_point(class_scope:google.api.BackendRule.OverridesByRequestProtocolEntry)
+            },
+        ),
         "DESCRIPTOR": _BACKENDRULE,
         "__module__": "google.api.backend_pb2"
         # @@protoc_insertion_point(class_scope:google.api.BackendRule)
     },
 )
 _sym_db.RegisterMessage(BackendRule)
+_sym_db.RegisterMessage(BackendRule.OverridesByRequestProtocolEntry)
 
 if _descriptor._USE_C_DESCRIPTORS == False:
 
     DESCRIPTOR._options = None
     DESCRIPTOR._serialized_options = b"\n\016com.google.apiB\014BackendProtoP\001ZEgoogle.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig\242\002\004GAPI"
+    _BACKENDRULE_OVERRIDESBYREQUESTPROTOCOLENTRY._options = None
+    _BACKENDRULE_OVERRIDESBYREQUESTPROTOCOLENTRY._serialized_options = b"8\001"
     _BACKENDRULE.fields_by_name["min_deadline"]._options = None
     _BACKENDRULE.fields_by_name["min_deadline"]._serialized_options = b"\030\001"
     _BACKEND._serialized_start = 40
     _BACKEND._serialized_end = 89
     _BACKENDRULE._serialized_start = 92
-    _BACKENDRULE._serialized_end = 466
-    _BACKENDRULE_PATHTRANSLATION._serialized_start = 347
-    _BACKENDRULE_PATHTRANSLATION._serialized_end = 448
+    _BACKENDRULE._serialized_end = 654
+    _BACKENDRULE_OVERRIDESBYREQUESTPROTOCOLENTRY._serialized_start = 443
+    _BACKENDRULE_OVERRIDESBYREQUESTPROTOCOLENTRY._serialized_end = 533
+    _BACKENDRULE_PATHTRANSLATION._serialized_start = 535
+    _BACKENDRULE_PATHTRANSLATION._serialized_end = 636
 # @@protoc_insertion_point(module_scope)
diff --git a/packages/googleapis-common-protos/google/api/billing.proto b/packages/googleapis-common-protos/google/api/billing.proto
@@ -1,4 +1,4 @@
-// Copyright 2015 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -59,11 +59,13 @@ message Billing {
   // bill against consumer project).
   message BillingDestination {
     // The monitored resource type. The type must be defined in
-    // [Service.monitored_resources][google.api.Service.monitored_resources] section.
+    // [Service.monitored_resources][google.api.Service.monitored_resources]
+    // section.
     string monitored_resource = 1;
 
     // Names of the metrics to report to this billing destination.
-    // Each name must be defined in [Service.metrics][google.api.Service.metrics] section.
+    // Each name must be defined in
+    // [Service.metrics][google.api.Service.metrics] section.
     repeated string metrics = 2;
   }
 

diff --git a/packages/googleapis-common-protos/google/api/client.proto b/packages/googleapis-common-protos/google/api/client.proto
@@ -1,4 +1,4 @@
-// Copyright 2018 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -112,7 +112,9 @@ message CommonLanguageSettings {
 
 // Details about how and where to publish client libraries.
 message ClientLibrarySettings {
-  // Version of the API to apply these settings to.
+  // Version of the API to apply these settings to. This is the full protobuf
+  // package for the API, ending in the version element.
+  // Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
   string version = 1;
 
   // Launch stage of this version of the API.
@@ -186,6 +188,10 @@ message Publishing {
   // times in this list, then the last one wins.  Settings from earlier
   // settings with the same version string are discarded.
   repeated ClientLibrarySettings library_settings = 109;
+
+  // Optional link to proto reference documentation.  Example:
+  // https://cloud.google.com/pubsub/lite/docs/reference/rpc
+  string proto_reference_documentation_uri = 110;
 }
 
 // Settings for Java client libraries.
@@ -302,8 +308,8 @@ message MethodSettings {
   // Example of a YAML configuration::
   //
   //  publishing:
-  //    method_behavior:
-  //      - selector: CreateAdDomain
+  //    method_settings:
+  //      - selector: google.cloud.speech.v2.Speech.BatchRecognize
   //        long_running:
   //          initial_poll_delay:
   //            seconds: 60 # 1 minute