docs: library generation example of Geo #8745
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alicejli
reviewed
Nov 8, 2022
| --name-pretty="Routes API" \ | ||
| --product-docs="https://developers.google.com/maps/documentation/routes" \ | ||
| --api-description="Routes API is the next generation, performance optimized version of the existing Directions API and Distance Matrix API. It helps you find the ideal route from A to Z, calculates ETAs and distances for matrices of origin and destination locations, and also offers new features." \ | ||
| --api-id=routes.googleapis.com \ |
| --api-description="Routes API is the next generation, performance optimized version of the existing Directions API and Distance Matrix API. It helps you find the ideal route from A to Z, calculates ETAs and distances for matrices of origin and destination locations, and also offers new features." \ | ||
| --api-id=routes.googleapis.com \ | ||
| --cloud-api=false \ | ||
| --requires-billing=true \ |
There was a problem hiding this comment.
should requires-billing be set in general?
| --api-id=routes.googleapis.com \ | ||
| --cloud-api=false \ | ||
| --requires-billing=true \ | ||
| --distribution-name="com.google.maps:google-maps-routing" |
There was a problem hiding this comment.
what does distribution-name map to?
There was a problem hiding this comment.
It's Group ID and artifact ID.
|
@alicejli Good point. I've enriched the "help" option of the command and added these explanation. PTAL. |
alicejli
approved these changes
Nov 10, 2022
generation/new_client/README.md
Outdated
| The first library generation is always | ||
| 'preview'. | ||
| --transport [grpc|http|both] A label that appears in repo-metadata.json | ||
| --language TEXT |
There was a problem hiding this comment.
Consider adding short description: "Defaults to 'java'".
| --api-id TEXT The value of the apiid parameter used in | ||
| README.md It has link to https://console.clo | ||
| ud.google.com/flows/enableapi?apiid=<api_id> | ||
| --requires-billing BOOLEAN Based on this value, README.md explains |
There was a problem hiding this comment.
Consider adding: "Defaults to true".
There was a problem hiding this comment.
Added default values in help.
| distribution name is not set | ||
| --owlbot-image TEXT The owlbot container image used in | ||
| OwlBot.yaml | ||
| --library-type TEXT A label that appear in repo-metadata.json to |
There was a problem hiding this comment.
Consider adding: "Defaults to GAPIC_AUTO".
| A label that appears in repo-metadata.json. | ||
| The first library generation is always | ||
| 'preview'. | ||
| --transport [grpc|http|both] A label that appears in repo-metadata.json |
There was a problem hiding this comment.
Consider adding: "Defaults to grpc"
There was a problem hiding this comment.
Added default values in help.
As per https://click.palletsprojects.com/en/8.1.x/options/ we can show the default value in help if we specify show_default= True
suztomo
commented
Dec 5, 2022
| --api-id TEXT The value of the apiid parameter used in | ||
| README.md It has link to https://console.clo | ||
| ud.google.com/flows/enableapi?apiid=<api_id> | ||
| --requires-billing BOOLEAN Based on this value, README.md explains |
There was a problem hiding this comment.
Added default values in help.
| A label that appears in repo-metadata.json. | ||
| The first library generation is always | ||
| 'preview'. | ||
| --transport [grpc|http|both] A label that appears in repo-metadata.json |
There was a problem hiding this comment.
Added default values in help.
suztomo
added
the
automerge
gcf-merge-on-green
bot
removed
the
automerge
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding an advanced options for client library generation.