googleapis / googleapis/synthtool

Java README template needs an `api_name` in addition to `name` and `name_pretty`

Open
#927 0 comments 0 reactions 1 assignee Claimed by @chingor13 View on GitHub
lang: java type: docs type: feature request
Dominant language
Python
Stars
108
Forks
102
Avg merge
1h 23m
Merged PRs (30d)
1

Description

[`java-pubsublite-kafka`](https://github.com/googleapis/java-pubsublite-kafka/blob/master/.repo-metadata.json) and [`java-pubsublite-spark`](https://github.com/googleapis/java-pubsublite-spark/blob/master/.repo-metadata.json) are libraries tied to the Pub/Sub Lite API, which has its own library [`java-pubsublite`](https://github.com/googleapis/java-pubsublite/blob/master/.repo-metadata.json).

Because the current `.repo-metadata.json` files don't differentiate between service API names and the repo names, the generated README files are misleading at places.

For example, the [paragraph](https://github.com/googleapis/java-pubsublite-spark#getting-started) below should say "Pub/Sub Lite" instead of "Pub/Sub Lite Spark Connector" (which comes from `{{metadata['repo']['name_pretty']}}`).

![Screen Shot 2021-01-27 at 10 47 06 AM](https://user-images.githubusercontent.com/9518298/106039793-66b9b080-608e-11eb-8f32-8dbbe20f774f.png)

This could be fixed if an `api_name` exists in `.repo-metadata.json` or if the template derives the API name from the `api_id` field instead of the `name` field.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.