Skip to content

Commit 68319f5

Browse files
committed
docs: update templates and config to support librarian regeneration
Updates the shared README.md template to support 'rest' and 'grpc+rest' transports, ensuring Transport section is not empty when regenerated. Updates `librarian.yaml` client documentation overrides to use `/latest/overview` instead of `/latest/history` to prevent librarian from reverting link fixes. Updates `.repo-metadata.json` transport values for affected major libraries (datastore, pubsub, storage) to match librarian output.
1 parent 9a561d2 commit 68319f5

5 files changed

Lines changed: 16 additions & 16 deletions

File tree

‎java-datastore/.repo-metadata.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"api_description": "is a fully managed, schemaless database for\\nstoring non-relational data. Cloud Datastore automatically scales with\\nyour users and supports ACID transactions, high availability of reads and\\nwrites, strong consistency for reads and ancestor queries, and eventual\\nconsistency for all other queries.",
66
"client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-datastore/latest/overview",
77
"release_level": "stable",
8-
"transport": "both",
8+
"transport": "grpc+rest",
99
"language": "java",
1010
"repo": "googleapis/google-cloud-java",
1111
"repo_short": "java-datastore",
@@ -18,4 +18,4 @@
1818
"issue_tracker": "https://issuetracker.google.com/savedsearches/559768",
1919
"extra_versioned_modules": "datastore-v1-proto-client",
2020
"recommended_package": "com.google.cloud.datastore"
21-
}
21+
}

‎java-pubsub/.repo-metadata.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"api_description": "is designed to provide reliable, many-to-many, asynchronous messaging between applications. Publisher applications can send messages to a topic and other applications can subscribe to that topic to receive the messages. By decoupling senders and receivers, Google Cloud Pub/Sub allows developers to communicate between independently written applications.",
66
"client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-pubsub/latest/overview",
77
"release_level": "stable",
8-
"transport": "both",
8+
"transport": "grpc+rest",
99
"language": "java",
1010
"repo": "googleapis/google-cloud-java",
1111
"repo_short": "java-pubsub",

‎java-storage/.repo-metadata.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"api_description": "is a durable and highly available object storage service. Google Cloud Storage is almost infinitely scalable and guarantees consistency: when a write succeeds, the latest copy of the object will be returned to any GET, globally.",
66
"client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/overview",
77
"release_level": "stable",
8-
"transport": "http",
8+
"transport": "rest",
99
"language": "java",
1010
"repo": "googleapis/google-cloud-java",
1111
"repo_short": "java-storage",

‎librarian.yaml‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -722,7 +722,7 @@ libraries:
722722
java:
723723
api_id_override: bigquerystorage.googleapis.com
724724
api_description_override: is an API for reading data stored in BigQuery. This API provides direct, high-throughput read access to existing BigQuery tables, supports parallel access with automatic liquid sharding, and allows fine-grained control over what data is returned.
725-
client_documentation_override: https://cloud.google.com/java/docs/reference/google-cloud-bigquerystorage/latest/history
725+
client_documentation_override: https://cloud.google.com/java/docs/reference/google-cloud-bigquerystorage/latest/overview
726726
codeowner_team: '@googleapis/bigquery-team'
727727
issue_tracker_override: https://issuetracker.google.com/savedsearches/559654
728728
library_type_override: GAPIC_COMBO
@@ -745,7 +745,7 @@ libraries:
745745
java:
746746
api_id_override: bigtable.googleapis.com
747747
api_description_override: API for reading and writing the contents of Bigtables associated with a cloud project.
748-
client_documentation_override: https://cloud.google.com/java/docs/reference/google-cloud-bigtable/latest/history
748+
client_documentation_override: https://cloud.google.com/java/docs/reference/google-cloud-bigtable/latest/overview
749749
codeowner_team: '@googleapis/bigtable-team'
750750
excluded_poms:
751751
- google-cloud-bigtable-bom
@@ -1049,7 +1049,7 @@ libraries:
10491049
api_description_override: Protobuf classes for Google's common protos.
10501050
api_shortname_override: common-protos
10511051
artifact_id: proto-google-common-protos
1052-
client_documentation_override: https://cloud.google.com/java/docs/reference/proto-google-common-protos/latest/history
1052+
client_documentation_override: https://cloud.google.com/java/docs/reference/proto-google-common-protos/latest/overview
10531053
excluded_dependencies: grpc-google-common-protos,proto-google-common-protos,proto-google-common-protos-parent
10541054
excluded_poms:
10551055
- proto-google-common-protos-bom
@@ -1342,7 +1342,7 @@ libraries:
13421342
java:
13431343
api_id_override: datastore.googleapis.com
13441344
api_description_override: is a fully managed, schemaless database for\nstoring non-relational data. Cloud Datastore automatically scales with\nyour users and supports ACID transactions, high availability of reads and\nwrites, strong consistency for reads and ancestor queries, and eventual\nconsistency for all other queries.
1345-
client_documentation_override: https://cloud.google.com/java/docs/reference/google-cloud-datastore/latest/history
1345+
client_documentation_override: https://cloud.google.com/java/docs/reference/google-cloud-datastore/latest/overview
13461346
excluded_dependencies: grpc-google-cloud-datastore-v1
13471347
excluded_poms:
13481348
- grpc-google-cloud-datastore-v1
@@ -1691,7 +1691,7 @@ libraries:
16911691
java:
16921692
api_id_override: firestore.googleapis.com
16931693
api_description_override: is a fully-managed NoSQL document database for mobile, web, and server development from Firebase and Google Cloud Platform. It's backed by a multi-region replicated database that ensures once data is committed, it's durable even in the face of unexpected disasters. Not only that, but despite being a distributed database, it's also strongly consistent and offers seamless integration with other Firebase and Google Cloud Platform products, including Google Cloud Functions.
1694-
client_documentation_override: https://cloud.google.com/java/docs/reference/google-cloud-firestore/latest/history
1694+
client_documentation_override: https://cloud.google.com/java/docs/reference/google-cloud-firestore/latest/overview
16951695
codeowner_team: '@googleapis/firestore-team'
16961696
excluded_poms:
16971697
- google-cloud-firestore
@@ -2050,7 +2050,7 @@ libraries:
20502050
api_description_override: n/a
20512051
api_shortname_override: iam-policy
20522052
artifact_id: google-iam-policy
2053-
client_documentation_override: https://cloud.google.com/java/docs/reference/proto-google-iam-v1/latest/history
2053+
client_documentation_override: https://cloud.google.com/java/docs/reference/proto-google-iam-v1/latest/overview
20542054
excluded_dependencies: google-iam-policy
20552055
excluded_poms:
20562056
- proto-google-iam-v1-bom
@@ -2227,7 +2227,7 @@ libraries:
22272227
java:
22282228
api_id_override: logging.googleapis.com
22292229
api_description_override: allows you to store, search, analyze, monitor, and alert on log data and events from Google Cloud and Amazon Web Services. Using the BindPlane service, you can also collect this data from over 150 common application components, on-premises systems, and hybrid cloud systems. BindPlane is included with your Google Cloud project at no additional cost.
2230-
client_documentation_override: https://cloud.google.com/java/docs/reference/google-cloud-logging/latest/history
2230+
client_documentation_override: https://cloud.google.com/java/docs/reference/google-cloud-logging/latest/overview
22312231
codeowner_team: '@googleapis/cloud-sdk-java-team'
22322232
issue_tracker_override: https://issuetracker.google.com/savedsearches/559764
22332233
library_type_override: GAPIC_COMBO
@@ -2901,7 +2901,7 @@ libraries:
29012901
api_id_override: pubsub.googleapis.com
29022902
api_reference: https://cloud.google.com/pubsub/
29032903
api_description_override: is designed to provide reliable, many-to-many, asynchronous messaging between applications. Publisher applications can send messages to a topic and other applications can subscribe to that topic to receive the messages. By decoupling senders and receivers, Google Cloud Pub/Sub allows developers to communicate between independently written applications.
2904-
client_documentation_override: https://cloud.google.com/java/docs/reference/google-cloud-pubsub/latest/history
2904+
client_documentation_override: https://cloud.google.com/java/docs/reference/google-cloud-pubsub/latest/overview
29052905
codeowner_team: '@googleapis/pubsub-team'
29062906
issue_tracker_override: https://issuetracker.google.com/savedsearches/559741
29072907
library_type_override: GAPIC_COMBO
@@ -3460,7 +3460,7 @@ libraries:
34603460
java:
34613461
api_id_override: spanner.googleapis.com
34623462
api_description_override: is a fully managed, mission-critical, relational database service that offers transactional consistency at global scale, schemas, SQL (ANSI 2011 with extensions), and automatic, synchronous replication for high availability. Be sure to activate the Cloud Spanner API on the Developer's Console to use Cloud Spanner from your project.
3463-
client_documentation_override: https://cloud.google.com/java/docs/reference/google-cloud-spanner/latest/history
3463+
client_documentation_override: https://cloud.google.com/java/docs/reference/google-cloud-spanner/latest/overview
34643464
codeowner_team: '@googleapis/spanner-team'
34653465
excluded_poms:
34663466
- google-cloud-spanner-bom
@@ -3530,7 +3530,7 @@ libraries:
35303530
java:
35313531
api_id_override: storage.googleapis.com
35323532
api_description_override: 'is a durable and highly available object storage service. Google Cloud Storage is almost infinitely scalable and guarantees consistency: when a write succeeds, the latest copy of the object will be returned to any GET, globally.'
3533-
client_documentation_override: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/history
3533+
client_documentation_override: https://cloud.google.com/java/docs/reference/google-cloud-storage/latest/overview
35343534
codeowner_team: '@googleapis/gcs-team'
35353535
excluded_poms:
35363536
- google-cloud-storage-bom

‎sdk-platform-java/hermetic_build/library_generation/owlbot/templates/java_library/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,9 +166,9 @@ To get help, follow the instructions in the [shared Troubleshooting document][tr
166166

167167
{% if metadata['repo']['transport'] == 'grpc' -%}
168168
{{metadata['repo']['name_pretty']}} uses gRPC for the transport layer.
169-
{% elif metadata['repo']['transport'] == 'http' -%}
169+
{% elif metadata['repo']['transport'] == 'http' or metadata['repo']['transport'] == 'rest' -%}
170170
{{metadata['repo']['name_pretty']}} uses HTTP/JSON for the transport layer.
171-
{% elif metadata['repo']['transport'] == 'both' -%}
171+
{% elif metadata['repo']['transport'] == 'both' or metadata['repo']['transport'] == 'grpc+rest' -%}
172172
{{metadata['repo']['name_pretty']}} uses both gRPC and HTTP/JSON for the transport layer.
173173
{% endif %}
174174
{% endif -%}

0 commit comments

Comments
 (0)