Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename {resource}_id guidance to id #111

Open
toumorokoshi opened this issue Apr 8, 2023 · 3 comments
Open

rename {resource}_id guidance to id #111

toumorokoshi opened this issue Apr 8, 2023 · 3 comments

Comments

@toumorokoshi
Copy link
Contributor

inspired by: aip-dev/google.aip.dev#1063

For google, the convention of {resource}_id is well ingrained into the sdks, and changing that expectation would be harmful for customers and the generated clients.

For overall APIs, removing the need to unnescessary inclusions of the resource singular would reduce the cost of code generated tooling.

We should look at changing the guidance in the general AIPs. @rofrankel also has a doc that suggests that we may want to re-evaluate the naming scheme on a broader level (e.g. with the convention to have name).

@rofrankel
Copy link
Contributor

rofrankel commented Apr 10, 2023

+1, we have made this change at Roblox already (in addition to the name -> path one you referenced).

@trg100
Copy link

trg100 commented Apr 12, 2023

@rofrankel also has a doc

Interested to see this. Is it public somewhere?

@rofrankel
Copy link
Contributor

rofrankel commented Apr 14, 2023

Afraid it's not currently public; we've talked about making our AIPs public but no solid plan yet. Some of what we've been working on will be reflected in this repo though. :)

Also, regarding the original issue: there are other places this comes up, e.g. repeated Book books in a ListBooksResponse. Could books just be something like items?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants