docs: update the list of available APIs - #9253
Conversation
|
/gcbrun |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds the Merchant Loyalty Customers package (@google-shopping/loyaltycustomers) to README.md and libraries.json. The reviewer noted that the display name 'Merchant' is too generic and should be updated to 'Merchant Loyalty Customers' in both files to prevent confusion. Additionally, the client documentation URL in libraries.json should point to the specific package rather than the generic API. Since these files are auto-generated, these corrections should be applied upstream in the generator rather than edited manually.
| "api_description": "Programmatically manage your Merchant Center Accounts.", | ||
| "api_id": "merchantapi.googleapis.com", | ||
| "api_shortname": "merchantapi", | ||
| "client_documentation": "https://cloud.google.com/nodejs/docs/reference/merchantapi/latest", |
There was a problem hiding this comment.
The client documentation URL should point to the reference docs for the specific package @google-shopping/loyaltycustomers (usually under the package name without scope, i.e., loyaltycustomers), rather than the generic merchantapi which may not exist or may be too broad. Please do not manually edit this generated client configuration file; any changes or updates must be made upstream in the generator.
References
- Do not manually edit generated client configuration JSON files. Any changes or updates must be made upstream in the generator.
| "language": "nodejs", | ||
| "library_type": "GAPIC_AUTO", | ||
| "name": "merchantapi", | ||
| "name_pretty": "Merchant", |
There was a problem hiding this comment.
Using Merchant as the pretty name is too generic because the Merchant API consists of multiple sub-packages (e.g., Accounts, Inventories, Products, Loyalty Customers). To avoid naming conflicts and confusion in the generated list, please use a more specific name like Merchant Loyalty Customers. Note that this file is a generated client configuration, so please do not edit it manually; make this change upstream in the generator.
References
- Do not manually edit generated client configuration JSON files. Any changes or updates must be made upstream in the generator.
| | [Media Translation](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-mediatranslation) | [![Preview][preview-stability]][launch-stages] | [](https://npm.im/@google-cloud/media-translation) | | ||
| | [Memorystore](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-memorystore) | [![Preview][preview-stability]][launch-stages] | [](https://npm.im/@google-cloud/memorystore) | | ||
| | [Memorystore for Redis](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-redis-cluster) | [![Preview][preview-stability]][launch-stages] | [](https://npm.im/@google-cloud/redis-cluster) | | ||
| | [Merchant](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-shopping-merchant-loyaltycustomers) | [![Preview][preview-stability]][launch-stages] | [](https://npm.im/@google-shopping/loyaltycustomers) | |
There was a problem hiding this comment.
Please update the display name to Merchant Loyalty Customers to accurately reflect that this package is specifically for the Loyalty Customers sub-API, and to prevent confusion with other Merchant API packages. Since this README is auto-generated, please do not edit it manually; apply the fixes upstream in the generator or templates.
References
- Do not manually edit auto-generated files to fix typos or make other changes, as these edits will be overwritten during the next regeneration. Instead, apply the fixes upstream in the generator or templates.
373d19c to
dd90d03
Compare
|
/gcbrun |
2 participants
Update the list of available APIs in the README.