docs: Use AlloyDB API for consistency with the official documentation. #264
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
ttosta-google
requested review from
cthumuluru,
nancynh and
a team
as code owners
README.md
Outdated
| @@ -64,7 +64,7 @@ This package requires the following to connect successfully: | |||
| Client][client-role] role or equivalent. [Credentials](#credentials) | |||
| for the IAM principal are used to authorize connections to an AlloyDB instance. | |||
|
|
|||
| * The [AlloyDB Admin API][admin-api] to be enabled within your Google Cloud | |||
| * The [AlloyDB API][admin-api] to be enabled within your Google Cloud | |||
There was a problem hiding this comment.
should we change the shortcut URL too so it isnt admin-api?
jackwotherspoon
requested changes
Mar 4, 2024
There was a problem hiding this comment.
@ttosta-google looks like a couple doc strings also say "admin", should those be updated too?
/~https://github.com/search?q=repo%3AGoogleCloudPlatform%2Falloydb-python-connector%20admin&type=code
|
Thanks @jackwotherspoon for catching it. I've update them. |
jackwotherspoon
approved these changes
Mar 4, 2024
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.
We received feedback from customers indicating confusion regarding the usage of
AlloyDB Admin APIin our documentation. To address this, we are updating the API reference toAlloyDB API, as recommended in the official documentation.